ansible / ansible.builtin / v2.7.9 / module / nxos_pim_interface Manages PIM interface configuration. | "added in version" 2.2 of ansible.builtin" Authors: Jason Edelman (@jedelman8) preview | supported by networkansible.builtin.nxos_pim_interface (v2.7.9) — module
pip
Install with pip install ansible==2.7.9
Manages PIM interface configuration settings.
# ensure PIM is not running on the interface - nxos_pim_interface: interface: eth1/33 state: absent
# ensure the interface has pim-sm enabled with the appropriate priority and hello interval - nxos_pim_interface: interface: eth1/33 dr_prio: 10 hello_interval: 40 state: present
# ensure join-prune policies exist - nxos_pim_interface: interface: eth1/33 jp_policy_in: JPIN jp_policy_out: JPOUT jp_type_in: routemap jp_type_out: routemap
# ensure defaults are in place - nxos_pim_interface: interface: eth1/33 state: default
state: choices: - present - default default: present description: - Manages desired state of the resource. border: default: 'no' description: - Configures interface to be a boundary of a PIM domain. type: bool sparse: default: 'no' description: - Enable/disable sparse-mode on the interface. type: bool dr_prio: description: - Configures priority for PIM DR election on interface. provider: description: - B(Deprecated) - 'Starting with Ansible 2.5 we recommend using C(connection: network_cli).' - 'Starting with Ansible 2.6 we recommend using C(connection: httpapi) for NX-API.' - This option will be removed in a release after 2022-06-01. - For more information please see the L(NXOS Platform Options guide, ../network/user_guide/platform_nxos.html). - HORIZONTALLINE - A dict object containing connection details. suboptions: auth_pass: description: - Specifies the password to use if required to enter privileged mode on the remote device. If I(authorize) is false, then this argument does nothing. If the value is not specified in the task, the value of environment variable C(ANSIBLE_NET_AUTH_PASS) will be used instead. type: str authorize: default: false description: - Instructs the module to enter privileged mode on the remote device before sending any commands. If not specified, the device will attempt to execute all commands in non-privileged mode. If the value is not specified in the task, the value of environment variable C(ANSIBLE_NET_AUTHORIZE) will be used instead. type: bool host: description: - 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. type: str password: description: - Specifies the password to use to authenticate the connection to the remote device. This is a common argument used for either I(cli) or I(nxapi) transports. If the value is not specified in the task, the value of environment variable C(ANSIBLE_NET_PASSWORD) will be used instead. type: str port: description: - Specifies the port to use when building the connection to the remote device. This value applies to either I(cli) or I(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). type: int ssh_keyfile: description: - Specifies the SSH key to use to authenticate the connection to the remote device. This argument is only used for the I(cli) transport. If the value is not specified in the task, the value of environment variable C(ANSIBLE_NET_SSH_KEYFILE) will be used instead. type: str timeout: description: - 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). type: int transport: choices: - cli - nxapi default: cli description: - 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. type: str use_proxy: default: true description: - If C(no), the environment variables C(http_proxy) and C(https_proxy) will be ignored. type: bool use_ssl: default: false description: - Configures the I(transport) to use SSL if set to C(yes) only when the C(transport=nxapi), otherwise this value is ignored. type: bool username: description: - 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 C(ANSIBLE_NET_USERNAME) will be used instead. type: str validate_certs: default: false description: - If C(no), SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. If the transport argument is not nxapi, this value is ignored. type: bool type: dict interface: description: - Full name of the interface such as Ethernet1/33. required: true jp_type_in: choices: - prefix - routemap description: - Type of policy mapped to C(jp_policy_in). jp_type_out: choices: - prefix - routemap description: - Type of policy mapped to C(jp_policy_out). jp_policy_in: description: - Policy for join-prune messages (inbound). jp_policy_out: description: - Policy for join-prune messages (outbound). neighbor_type: choices: - prefix - routemap description: - Type of policy mapped to neighbor_policy. hello_auth_key: description: - Authentication for hellos on this interface. hello_interval: description: - Hello interval in milliseconds for this interface. type: bool neighbor_policy: description: - Configures a neighbor policy for filtering adjacencies.
commands: description: command sent to the device returned: always sample: - interface eth1/33 - ip pim neighbor-policy test - ip pim neighbor-policy test type: list