Docs4dev
Docs
ansible / latest / collections / cisco / nxos / nxos_pim_interface_module.html

cisco.nxos.nxos_pim_interface – Manages PIM interface configuration.

Note

This plugin is part of the cisco.nxos collection (version 2.7.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install cisco.nxos.

To use it in a playbook, specify: cisco.nxos.nxos_pim_interface.

New in version 1.0.0: of cisco.nxos

Synopsis

  • Manages PIM interface configuration settings.

Note

This module has a corresponding action plugin.

Parameters

Parameter Choices/Defaults Comments
bfd
string
    Choices:
  • enable
  • disable
  • default
Enables BFD for PIM at the interface level. This overrides the bfd variable set at the pim global level.
Valid values are 'enable', 'disable' or 'default'.
Dependency: ''feature bfd''
border
boolean
    Choices:
  • no ←
  • yes
Configures interface to be a boundary of a PIM domain.
dr_prio
string
Configures priority for PIM DR election on interface.
hello_auth_key
string
Authentication for hellos on this interface.
hello_interval
integer
Hello interval in milliseconds or seconds for this interface.
Use the option hello_interval_ms to specify if the given value is in milliseconds or seconds. The default is seconds.
hello_interval_ms
boolean
added in 2.0.0 of cisco.nxos
    Choices:
  • no
  • yes
Specifies that the hello_interval is in milliseconds.
When set to True, this indicates that the user is providing the hello_interval in milliseconds and hence, no conversion is required.
interface
string / required
Full name of the interface such as Ethernet1/33.
jp_policy_in
string
Policy for join-prune messages (inbound).
jp_policy_out
string
Policy for join-prune messages (outbound).
jp_type_in
string
    Choices:
  • prefix
  • routemap
Type of policy mapped to jp_policy_in.
jp_type_out
string
    Choices:
  • prefix
  • routemap
Type of policy mapped to jp_policy_out.
neighbor_policy
string
Configures a neighbor policy for filtering adjacencies.
neighbor_type
string
    Choices:
  • prefix
  • routemap
Type of policy mapped to neighbor_policy.
provider
dictionary
Deprecated
Starting with Ansible 2.5 we recommend using connection: network_cli.
Starting with Ansible 2.6 we recommend using connection: httpapi for NX-API.
This option will be removed in a release after 2022-06-01.
A dict object containing connection details.
auth_pass
string
Specifies the password to use if required to enter privileged mode on the remote device. If authorize is false, then this argument does nothing. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_AUTH_PASS will be used instead.
authorize
boolean
    Choices:
  • no ←
  • yes
Instructs the module to enter privileged mode on the remote device before sending any commands. If not specified, the device will attempt to execute all commands in non-privileged mode. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_AUTHORIZE will be used instead.
host
string
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
password
string
Specifies the password to use to authenticate the connection to the remote device. This is a common argument used for either cli or nxapi transports. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
port
integer
Specifies the port to use when building the connection to the remote device. This value applies to either cli or nxapi. The port value will default to the appropriate transport common port if none is provided in the task. (cli=22, http=80, https=443).
ssh_keyfile
string
Specifies the SSH key to use to authenticate the connection to the remote device. This argument is only used for the cli transport. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_SSH_KEYFILE will be used instead.
timeout
integer
Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. NX-API can be slow to return on long-running commands (sh mac, sh bgp, etc).
transport
string
    Choices:
  • cli ←
  • nxapi
Configures the transport connection to use when connecting to the remote device. The transport argument supports connectivity to the device over cli (ssh) or nxapi.
use_proxy
boolean
    Choices:
  • no
  • yes ←
If no, the environment variables http_proxy and https_proxy will be ignored.
use_ssl
boolean
    Choices:
  • no ←
  • yes
Configures the transport to use SSL if set to yes only when the transport=nxapi, otherwise this value is ignored.
username
string
Configures the username to use to authenticate the connection to the remote device. This value is used to authenticate either the CLI login or the nxapi authentication depending on which transport is used. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
validate_certs
boolean
    Choices:
  • no ←
  • yes
If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. If the transport argument is not nxapi, this value is ignored.
sparse
boolean
    Choices:
  • no ←
  • yes
Enable/disable sparse-mode on the interface.
state
string
    Choices:
  • present ←
  • absent
  • default
Manages desired state of the resource.

Notes

Note

  • Tested against NXOSv 7.3.(0)D1(1) on VIRL
  • Unsupported for Cisco MDS
  • When state=default, supported params will be reset to a default state. These include dr_prio, hello_auth_key, hello_interval, jp_policy_out, jp_policy_in, jp_type_in, jp_type_out, border, neighbor_policy, neighbor_type.
  • The hello_auth_key param is not idempotent.
  • hello_auth_key only supports clear text passwords.
  • When state=absent, pim interface configuration will be set to defaults and pim-sm will be disabled on the interface.
  • PIM must be enabled on the device to use this module.
  • This module is for Layer 3 interfaces.
  • For information on using CLI and NX-API see the NXOS Platform Options guide
  • For more information on using Ansible to manage network devices see the Ansible Network Guide
  • For more information on using Ansible to manage Cisco devices see the Cisco integration page.

Examples

- name: Ensure PIM is not running on the interface
  cisco.nxos.nxos_pim_interface:
    interface: eth1/33
    state: absent

- name: Ensure the interface has pim-sm enabled with the appropriate priority and
    hello interval
  cisco.nxos.nxos_pim_interface:
    interface: eth1/33
    dr_prio: 10
    hello_interval: 40
    state: present

- name: Ensure join-prune policies exist
  cisco.nxos.nxos_pim_interface:
    interface: eth1/33
    jp_policy_in: JPIN
    jp_policy_out: JPOUT
    jp_type_in: routemap
    jp_type_out: routemap

- name: disable bfd on the interface
  cisco.nxos.nxos_pim_interface:
    interface: eth1/33
    bfd: disable

- name: Ensure defaults are in place
  cisco.nxos.nxos_pim_interface:
    interface: eth1/33
    state: default

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
commands
list / elements=string
always
command sent to the device

Sample:
['interface eth1/33', 'ip pim neighbor-policy test', 'ip pim bfd-instance disable', 'ip pim neighbor-policy test']


Authors

  • Jason Edelman (@jedelman8)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/cisco/nxos/nxos_pim_interface_module.html