cisco.nxos.nxos_pim_module.rst

cisco.nxos.nxos_pim

Manages configuration of a PIM instance.

Version added: 1.0.0

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

Synopsis

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

Parameters

Parameter	Choices/Defaults	Comments
bfd string	Choices: enable disable	Enables BFD on all PIM interfaces. Dependency: ''feature bfd''
ssm_range list / elements=string	Default: []	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.

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.

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	Returned	Description
commands list	always	commands sent to the device Sample: ['ip pim bfd', 'ip pim ssm range 224.0.0.0/8']

Status

Authors

• Gabriele Gerbino (@GGabriele)