cisco.nxos.nxos_pim_rp_address module – Manages configuration of an PIM static RP address instance.

Note

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

New in cisco.nxos 1.0.0

Synopsis

  • Manages configuration of an Protocol Independent Multicast (PIM) static rendezvous point (RP) address instance.

Note

This module has a corresponding action plugin.

Parameters

Parameter

Comments

bidir

boolean

Group range is treated in PIM bidirectional mode.

Choices:

  • false

  • true

group_list

string

Group range for static RP. Valid values are multicast addresses.

prefix_list

string

Prefix list policy for static RP. Valid values are prefix-list policy names.

route_map

string

Route map policy for static RP. Valid values are route-map policy names.

rp_address

string / required

Configures a Protocol Independent Multicast (PIM) static rendezvous point (RP) address. Valid values are unicast addresses.

state

string

Specify desired state of the resource.

Choices:

  • "present" ← (default)

  • "absent"

Notes

Note

  • Tested against NXOSv 7.3.(0)D1(1) on VIRL

  • Unsupported for Cisco MDS

  • state=absent is currently not supported on all platforms.

  • 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

- cisco.nxos.nxos_pim_rp_address:
    rp_address: 10.1.1.20
    state: present

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: ["router bgp 65535", "vrf test", "router-id 192.0.2.1"]

Authors

  • Gabriele Gerbino (@GGabriele)