W3cubDocs

/Ansible

cisco.nxos.nxos_pim module – Manages configuration of a PIM instance.

Note

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

New in cisco.nxos 1.0.0

Synopsis

  • Manages configuration of a Protocol Independent Multicast (PIM) instance.

Parameters

Parameter

Comments

bfd

string

Enables BFD on all PIM interfaces.

Dependency: ‘’feature bfd’’

Choices:

  • "enable"
  • "disable"

ssm_range

list / elements=string

Configure group ranges for Source Specific Multicast (SSM). Valid values are multicast addresses or the keyword none or keyword default. none removes all SSM group ranges. default will set ssm_range to the default multicast address. If you set multicast address, please ensure that it is not the same as the default, otherwise use the default option.

Default: []

Notes

Note

  • Unsupported for Cisco MDS
  • 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: Configure ssm_range, enable bfd
  cisco.nxos.nxos_pim:
    bfd: enable
    ssm_range: 224.0.0.0/8

- name: Set to default
  cisco.nxos.nxos_pim:
    ssm_range: default

- name: Remove all ssm group ranges
  cisco.nxos.nxos_pim:
    ssm_range: none

Return Values

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

Key

Description

commands

list / elements=string

commands sent to the device

Returned: always

Sample: ["ip pim bfd", "ip pim ssm range 224.0.0.0/8"]

Authors

  • Gabriele Gerbino (@GGabriele)

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