Documentation

nxos_pim_rp_address - Manages configuration of an PIM static RP address instance.

New in version 2.2.

Synopsis

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

Options

parameter required default choices comments
bidir
no
  • true
  • false
Group range is treated in PIM bidirectional mode.
group_list
no
Group range for static RP. Valid values are multicast addresses.
host
yes
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
password
no
Specifies the password to use to authenticate the connection to the remote device. This is a common argument used for either cli or nxapi transports. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
port
no 0 (use common port)
Specifies the port to use when building the connection to the remote device. This value applies to either cli or nxapi. The port value will default to the appropriate transport common port if none is provided in the task. (cli=22, http=80, https=443).
prefix_list
no
Prefix list policy for static RP. Valid values are prefix-list policy names.
provider
no
Convenience method that allows all nxos arguments to be passed as a dict object. All constraints (required, choices, etc) must be met either by individual arguments or values in this dict.
route_map
no
Route map policy for static RP. Valid values are route-map policy names.
rp_address
yes
Configures a Protocol Independent Multicast (PIM) static rendezvous point (RP) address. Valid values are unicast addresses.
ssh_keyfile
no
Specifies the SSH key to use to authenticate the connection to the remote device. This argument is only used for the cli transport. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_SSH_KEYFILE will be used instead.
timeout
(added in 2.3)
no 10
Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. NX-API can be slow to return on long-running commands (sh mac, sh bgp, etc).
transport
yes cli
Configures the transport connection to use when connecting to the remote device. The transport argument supports connectivity to the device over cli (ssh) or nxapi.
use_ssl
no
  • yes
  • no
Configures the transport to use SSL if set to true only when the transport=nxapi, otherwise this value is ignored.
username
no
Configures the username to use to authenticate the connection to the remote device. This value is used to authenticate either the CLI login or the nxapi authentication depending on which transport is used. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.

Examples

- nxos_pim_rp_address:
    rp_address: "10.1.1.20"
    state: present
    username: "{{ un }}"
    password: "{{ pwd }}"
    host: "{{ inventory_hostname }}"

Return Values

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

name description returned type sample
end_state pim rp-address configuration entries after module execution verbose mode list [{'bidir': False, 'rp_address': '10.1.1.21', 'group_list': '224.0.0.0/4'}]
changed check to see if a change was made on the device always boolean True
updates commands sent to the device always list ['router bgp 65535', 'vrf test', 'router-id 1.1.1.1']
proposed k/v pairs of parameters passed into module verbose mode dict {'rp_address': '10.1.1.21'}
existing list of existing pim rp-address configuration entries verbose mode list []


Notes

Note

  • state=absent remove the whole rp-address configuration, if existing.

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Support

This module is community maintained without core committer oversight.

For more information on what this means please read Module Support

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Helping Testing PRs and Developing Modules.