cisco.nxos.nxos_pim_interface module – Manages PIM interface configuration.
Note
This module is part of the cisco.nxos collection (version 3.2.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 cisco.nxos 1.0.0
Synopsis
Manages PIM interface configuration settings.
Note
This module has a corresponding action plugin.
Parameters
Parameter |
Comments |
---|---|
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’’ Choices:
|
|
Configures interface to be a boundary of a PIM domain. Choices:
|
|
Configures priority for PIM DR election on interface. |
|
Authentication for hellos on this interface. |
|
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. |
|
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. Choices:
|
|
Full name of the interface such as Ethernet1/33. |
|
Policy for join-prune messages (inbound). |
|
Policy for join-prune messages (outbound). |
|
Type of policy mapped to Choices:
|
|
Type of policy mapped to Choices:
|
|
Configures a neighbor policy for filtering adjacencies. |
|
Type of policy mapped to neighbor_policy. Choices:
|
|
Deprecated Starting with Ansible 2.5 we recommend using Starting with Ansible 2.6 we recommend using This option will be removed in a release after 2022-06-01. For more information please see the https://docs.ansible.com/ansible/latest/network/user_guide/platform_nxos.html. A dict object containing connection details. |
|
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 |
|
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 Choices:
|
|
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. |
|
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 |
|
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). |
|
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 |
|
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). |
|
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. Choices:
|
|
If Choices:
|
|
Configures the transport to use SSL if set to Choices:
|
|
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 |
|
If Choices:
|
|
Enable/disable sparse-mode on the interface. Choices:
|
|
Manages desired state of the resource. Choices:
|
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 includedr_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 :ref:`NXOS Platform Options guide <nxos_platform_options>`
For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide <network_guide>`
For more information on using Ansible to manage Cisco devices see the `Cisco integration page <https://www.ansible.com/integrations/networks/cisco>`_.
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 |
Description |
---|---|
command sent to the device Returned: always Sample: |