W3cubDocs

/Ansible

nxos_pim_interface - Manages PIM interface configuration.

New in version 2.2.

Synopsis

Manages PIM interface configuration settings.

Options

parameter required default choices comments
border
 no
  • true
  • false
Configures interface to be a boundary of a PIM domain.
hello_auth_key
 no
Authentication for hellos on this interface.
hello_interval
 no
  • true
  • false
Hello interval in milliseconds for this interface.
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.
interface
 yes
Full name of the interface such as Ethernet1/33.
jp_policy_in
 no
Policy for join-prune messages (inbound).
jp_policy_out
 yes
Policy for join-prune messages (outbound).
jp_type_in
 no
  • prefix
  • routemap
Type of policy mapped to jp_policy_in.
jp_type_out
 no
  • prefix
  • routemap
Type of policy mapped to jp_policy_out.
neighbor_policy
 no
Configures a neighbor policy for filtering adjacencies.
neighbor_type
 no
  • prefix
  • routemap
Type of policy mapped to neighbor_policy.
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).
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.
sparse
 no True
  • true
  • false
Enable/disable sparse-mode on the interface.
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.
state
 no present
  • present
  • default
Manages desired state of the resource.
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. The value of username 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

# ensure PIM is not running on the interface
- nxos_pim_interface:
    interface: eth1/33
    state: absent
    host: {{ inventory_hostname }}
    username: {{ un }}
    password: {{ pwd }}

# 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
    host: {{ inventory_hostname }}
    username: {{ un }}
    password: {{ pwd }}

# 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
    host: {{ inventory_hostname }}
    username: {{ un }}
    password: {{ pwd }}

# ensure defaults are in place
- nxos_pim_interface:
    interface: eth1/33
    state: default
    host: {{ inventory_hostname }}
    username: {{ un }}
    password: {{ pwd }}

Return Values

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

name description returned type sample
end_state k/v pairs of configuration after module execution always dict {'jp_bidir': False, 'dr_prio': '1', 'hello_interval': '30000', 'jp_policy_out': '1', 'jp_type_in': 'routemap', 'neighbor_type': 'routemap', 'neighbor_policy': 'test', 'sparse': True, 'isauth': False, 'jp_policy_in': 'JPIN', 'border': False, 'jp_type_out': None}
changed check to see if a change was made on the device always boolean True
updates command sent to the device always list ['interface eth1/33', 'ip pim neighbor-policy test', 'ip pim neighbor-policy test']
proposed k/v pairs of parameters passed into module always dict {'interface': 'eth1/33', 'neighbor_type': 'routemap', 'neighbor_policy': 'test', 'sparse': True}
existing ['k/v pairs of existing configuration'] dict {'jp_bidir': False, 'dr_prio': '1', 'hello_interval': '30000', 'jp_policy_out': '1', 'jp_type_in': 'routemap', 'neighbor_type': 'prefix', 'neighbor_policy': 'test1', 'sparse': True, 'isauth': False, 'jp_policy_in': 'JPIN', 'border': False, 'jp_type_out': None}

Notes

Note

When state=default, supported params will be reset to a default state. These include dr_prio, hello_auth_key, hello_interval, jp_policy_out, jp_policy_in, jp_type_in, jp_type_out, border, neighbor_policy, neighbor_type.

Note

The hello_auth_key param is not idempotent.

Note

hello_auth_key only supports clear text passwords.

Note

When state=absent, pim interface configuration will be set to defaults and pim-sm will be disabled on the interface.

Note

PIM must be enabled on the device to use this module.

Note

This module is for Layer 3 interfaces.

This is a Core Module

For more information on what this means please read Core Modules

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

© 2012–2016 Michael DeHaan
© 2016 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/nxos_pim_interface_module.html