cisco.nxos.nxos_pim_interface module – Manages PIM interface configuration.

Note

This module is part of the cisco.nxos collection (version 4.4.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

bfd

string

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:

  • "enable"

  • "disable"

  • "default"

border

boolean

Configures interface to be a boundary of a PIM domain.

Choices:

  • false ← (default)

  • true

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 cisco.nxos 2.0.0

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:

  • false

  • true

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

Type of policy mapped to jp_policy_in.

Choices:

  • "prefix"

  • "routemap"

jp_type_out

string

Type of policy mapped to jp_policy_out.

Choices:

  • "prefix"

  • "routemap"

neighbor_policy

string

Configures a neighbor policy for filtering adjacencies.

neighbor_type

string

Type of policy mapped to neighbor_policy.

Choices:

  • "prefix"

  • "routemap"

sparse

boolean

Enable/disable sparse-mode on the interface.

Choices:

  • false ← (default)

  • true

state

string

Manages desired state of the resource.

Choices:

  • "present" ← (default)

  • "absent"

  • "default"

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

commands

list / elements=string

command sent to the device

Returned: always

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

Authors

  • Jason Edelman (@jedelman8)