cisco.nxos.nxos_pim_interface (7.0.0) — module

Install collection

Install with ansible-galaxy collection install cisco.nxos:==7.0.0

Add to requirements.yml

  collections:
    - name: cisco.nxos
      version: 7.0.0

Description

Manages PIM interface configuration settings.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Ensure PIM is not running on the interface
  cisco.nxos.nxos_pim_interface:
    interface: eth1/33
    state: absent

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Ensure the interface has pim-sm enabled with the appropriate priority and
    hello interval
  cisco.nxos.nxos_pim_interface:
    interface: eth1/33
    dr_prio: 10
    hello_interval: 40
    state: present

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Ensure join-prune policies exist
  cisco.nxos.nxos_pim_interface:
    interface: eth1/33
    jp_policy_in: JPIN
    jp_policy_out: JPOUT
    jp_type_in: routemap
    jp_type_out: routemap

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: disable bfd on the interface
  cisco.nxos.nxos_pim_interface:
    interface: eth1/33
    bfd: disable

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Ensure defaults are in place
  cisco.nxos.nxos_pim_interface:
    interface: eth1/33
    state: default

Inputs

    
bfd:
    choices:
    - enable
    - disable
    - default
    description:
    - Enables BFD for PIM at the interface level. This overrides the bfd variable set
      at the pim global level.
    - Valid values are 'enable', 'disable' or 'default'.
    - 'Dependency: ''''feature bfd'''''
    type: str

state:
    choices:
    - present
    - absent
    - default
    default: present
    description:
    - Manages desired state of the resource.
    type: str

border:
    default: false
    description:
    - Configures interface to be a boundary of a PIM domain.
    type: bool

sparse:
    default: false
    description:
    - Enable/disable sparse-mode on the interface.
    type: bool

dr_prio:
    description:
    - Configures priority for PIM DR election on interface.
    type: str

interface:
    description:
    - Full name of the interface such as Ethernet1/33.
    required: true
    type: str

jp_type_in:
    choices:
    - prefix
    - routemap
    description:
    - Type of policy mapped to C(jp_policy_in).
    type: str

jp_type_out:
    choices:
    - prefix
    - routemap
    description:
    - Type of policy mapped to C(jp_policy_out).
    type: str

jp_policy_in:
    description:
    - Policy for join-prune messages (inbound).
    type: str

jp_policy_out:
    description:
    - Policy for join-prune messages (outbound).
    type: str

neighbor_type:
    choices:
    - prefix
    - routemap
    description:
    - Type of policy mapped to neighbor_policy.
    type: str

hello_auth_key:
    description:
    - Authentication for hellos on this interface.
    type: str

hello_interval:
    description:
    - Hello interval in milliseconds or seconds for this interface.
    - Use the option I(hello_interval_ms) to specify if the given value is in milliseconds
      or seconds. The default is seconds.
    type: int

neighbor_policy:
    description:
    - Configures a neighbor policy for filtering adjacencies.
    type: str

hello_interval_ms:
    description:
    - Specifies that the hello_interval is in milliseconds.
    - When set to True, this indicates that the user is providing the hello_interval in
      milliseconds and hence, no conversion is required.
    type: bool
    version_added: 2.0.0
    version_added_collection: cisco.nxos

Outputs

commands:
  description: command sent to the device
  returned: always
  sample:
  - interface eth1/33
  - ip pim neighbor-policy test
  - ip pim bfd-instance disable
  - ip pim neighbor-policy test
  type: list