ansible.builtin.nxos_pim (v2.9.13) — module

Install Ansible via pip

Install with pip install ansible==2.9.13

Description

Manages configuration of a Protocol Independent Multicast (PIM) instance.

Usage examples

Scanned by Steampunk Spotter

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

- name: Configure ssm_range, enable bfd
  nxos_pim:
    bfd: enable
    ssm_range: "224.0.0.0/8"

Scanned by Steampunk Spotter

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

- name: Set to default
  nxos_pim:
    ssm_range: default

Scanned by Steampunk Spotter

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

- name: Remove all ssm group ranges
  nxos_pim:
    ssm_range: none

Inputs

    
bfd:
    choices:
    - enable
    - disable
    description:
    - Enables BFD on all PIM interfaces.
    - 'Dependency: ''feature bfd'''
    type: str
    version_added: '2.9'
    version_added_collection: ansible.builtin

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

ssm_range:
    description:
    - Configure group ranges for Source Specific Multicast (SSM). Valid values are multicast
      addresses or the keyword C(none) or keyword C(default). C(none) removes all SSM
      group ranges. C(default) will set ssm_range to the default multicast address. If
      you set multicast address, please ensure that it is not the same as the C(default),
      otherwise use the C(default) option.
    required: true

Outputs

commands:
  description: commands sent to the device
  returned: always
  sample:
  - ip pim bfd
  - ip pim ssm range 224.0.0.0/8
  type: list