cisco.nxos.nxos_pim_interface_module.rst

cisco.nxos.nxos_pim_interface

Manages PIM interface configuration.

Version added: 1.0.0

• Synopsis
• Parameters
• Notes
• Examples
• Return Values
• Status

Synopsis

• Manages PIM interface configuration settings.

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	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.
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 :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.

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	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']

Status

Authors

• Jason Edelman (@jedelman8)