Skip to content

Latest commit

 

History

History
188 lines (144 loc) · 6.89 KB

cisco.nxos.nxos_pim_interface.rst

File metadata and controls

188 lines (144 loc) · 6.89 KB
Raw

NxosPimInterface()

ScriptKit Synopsis

  • NxosPimInterface() generates Ansible Playbook tasks conformant with cisco.nxos.nxos_pim_interface
  • These can then be passed to Playbook().add_task()

Ansible Module Documentation

ScriptKit Example

Dependencies

The following must be enabled prior to applying nxos_pim_interface playbook:

feature pim

Property Description
bfd

Enables BFD for PIM at the interface level. This overrides the bfd variable set at the pim global level:

- Type: str()
- Valid values:
    - enable
    - disable
    - default
- Dependencies: feature bfd
- Example:
    task.bfd = 'enable'
border

Configures interface to be a boundary of a PIM domain:

- Type: bool()
- Valid values:
    - False
    - True
- Example:
    task.border = True
dr_prio

Configures priority for PIM DR election on the interface:

- Type: int()
- Valid values:
    - range: 1-4294967295
- Example:
    task.dr_prio = 3000
hello_auth_key

Authentication for PIM hellos on this interface:

- Type: str()
- Example:
    task.hello_auth_key = 'zippofinetic'
hello_interval

Hello interval in milliseconds or seconds for this interface. Use the option hello_interval_ms to specify if the given value is in milliseconds or seconds. The default is seconds.:

- Type: int()
- Valid values:
    - range: 1-18724286
- Example (set pim hello interval to 100ms):
    task.hello_interval_ms = True
    task.hello_interval = 100
- Example (set pim hello interval to 1 second):
    task.hello_interval_ms = False
    task.hello_interval = 1
hello_interval_ms

Specifies that the hello_interval is in milliseconds. If set to True, the value of hello_interval will be interpreted as milliseconds. If set to False, the value of hello_interval will be interpreted as seconds.:

- Type: bool()
- Valid values:
    - False
    - True
- Version added: 2.0.0
- Example:
    task.hello_interval_ms = True
interface

Full name of the PIM interface:

- Type: str()
- Example:
    task.interface = 'Ethernet1/33'
- Required
jp_policy_in

Inbound policy for join-prune messages:

- Type: str()
- Example:
    task.jp_policy_in = 'PIM_JP_IN'
jp_policy_out

Outbound policy for join-prune messages:

- Type: str()
- Example:
    task.jp_policy_out = 'PIM_JP_OUT'
jp_type_in

Type of policy mapped to jp_policy_in:

- Type: str()
- Valid values:
    - prefix
    - routemap
- Example:
    task.jp_type_in = 'routemap'
jp_type_out

Type of policy mapped to jp_policy_out:

- Type: str()
- Valid values:
    - prefix
    - routemap
- Example:
    task.jp_type_out = 'routemap'
neighbor_policy

Configures a neighbor policy for filtering adjacencies:

- Type: str()
- Example:
    task.neighbor_policy = 'PIM_POLICY'
neighbor_type

Type of policy mapped to neighbor_policy:

- Type: str()
- Valid values:
    - prefix
    - routemap
- Example:
    task.neighbor_type = 'prefix'
sparse

Enable/disable sparse-mode on the interface:

- Type: bool()
- Valid values:
    - False
    - True
- Example:
    task.sparse = True
state

Desired state after task has completed:

- Type: str()
- Valid values:
    - absent
    - default
    - present
- Example:
    task.state = 'present'
- Required
task_name

Name of the task. Ansible will display this when the playbook is run:

- Type: str()
- Example:
    - task.task_name = 'my task'

Authors

  • Allen Robel (@PacketCalc)