W3cubDocs

/Ansible

cisco.mso.ndo_l3out_interface_routing_policy module – Manage L3Out Interface Routing Policies on Cisco Nexus Dashboard Orchestrator (NDO).

Note

This module is part of the cisco.mso collection (version 2.11.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install cisco.mso. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: cisco.mso.ndo_l3out_interface_routing_policy.

Synopsis

  • Manage L3Out Interface Routing Policies on Cisco Nexus Dashboard Orchestrator (NDO).
  • This module is only supported on ND v3.1 (NDO v4.3) and later.

Requirements

The below requirements are needed on the host that executes this module.

  • Multi Site Orchestrator v2.1 or newer

Parameters

Parameter

Comments

bfd_multi_hop_settings

dictionary

The Bidirectional Forwarding Detection (BFD) multi-hop configuration of the L3Out Interface Routing Policy.

admin_state

string

The administrative state of the BFD MultiHop Settings.

Defaults to enabled when unset during creation.

Choices:

  • "enabled"
  • "disabled"

detection_multiplier

integer

The detection multiplier of the BFD MultiHop Settings.

Defaults to 3 when unset during creation.

The value must be between 1 and 50.

min_receive_interval

integer

The minimum receive interval of the BFD MultiHop Settings.

Defaults to 250 when unset during creation.

The value must be between 250 and 999 microseconds.

min_transmit_interval

integer

The minimum transmit interval of the BFD MultiHop Settings.

Defaults to 250 when unset during creation.

The value must be between 250 and 999 microseconds.

state

string

Use enabled to configure the BFD MultiHop Settings.

Use disabled to remove the BFD MultiHop Settings.

Choices:

  • "enabled"
  • "disabled"

bfd_settings

dictionary

The BFD Settings of the L3Out Interface Routing Policy.

admin_state

string

The administrative state of the BFD Settings.

Defaults to enabled when unset during creation.

Choices:

  • "enabled"
  • "disabled"

detection_multiplier

integer

The detection multiplier of the BFD Settings.

Defaults to 3 when unset during creation.

The value must be between 1 and 50.

echo_admin_state

string

The echo administrative state of the BFD Settings.

Defaults to enabled when unset during creation.

Choices:

  • "enabled"
  • "disabled"

echo_receive_interval

integer

The echo receive interval in microseconds of the BFD Settings

Defaults to 50 when unset during creation.

The value must be between 50 and 999.

interface_control

string

The interface control of the BFD Settings.

Defaults to disabled when unset during creation.

Choices:

  • "enabled"
  • "disabled"

min_receive_interval

integer

The minimum receive interval in microseconds of the BFD Settings.

Defaults to 50 when unset during creation.

The value must be between 50 and 999.

min_transmit_interval

integer

The minimum transmit interval in microseconds of the BFD Settings.

Defaults to 50 when unset during creation.

The value must be between 50 and 999.

state

string

Use enabled to configure the BFD Settings.

Use disabled to remove the BFD Settings.

Choices:

  • "enabled"
  • "disabled"

description

string

The description of the L3Out Interface Routing Policy.

host

aliases: hostname

string

IP Address or hostname of the ACI Multi Site Orchestrator host.

If the value is not specified in the task, the value of environment variable MSO_HOST will be used instead.

login_domain

string

The login domain name to use for authentication.

The default value is Local.

If the value is not specified in the task, the value of environment variable MSO_LOGIN_DOMAIN will be used instead.

When using a HTTPAPI connection plugin the inventory variable ansible_httpapi_login_domain will be used if this attribute is not specified.

name

aliases: l3out_interface_routing_policy_name

string

The name of the L3Out Interface Routing Policy.

ospf_interface_settings

dictionary

The Open Shortest Path First (OSPF) Interface Settings of the L3Out Interface Routing Policy.

advertise_subnet

string

The advertise subnet of the OSPF Interface Settings.

Defaults to disabled when unset during creation.

Choices:

  • "enabled"
  • "disabled"

bfd

string

Enables or disables BFD in the OSPF Interface Settings.

Defaults to disabled when unset during creation.

Choices:

  • "enabled"
  • "disabled"

cost_of_interface

integer

The cost of the OSPF Interface Settings.

Defaults to 0 when unset during creation.

The value must be between 0 and 65535.

dead_interval

integer

The dead interval in seconds of the OSPF Interface Settings.

Defaults to 40 when unset during creation.

The value must be between 1 and 65535.

hello_interval

integer

The hello interval in seconds of the OSPF Interface Settings.

Defaults to 10 when unset during creation.

The value must be between 1 and 65535.

mtu_ignore

string

Enables or disables ignoring the Maximum Transmission Unit (MTU) in the OSPF Interface Settings.

Defaults to disabled when unset during creation.

Choices:

  • "enabled"
  • "disabled"

network_type

string

The network type of the OSPF Interface Settings.

Defaults to broadcast when unset during creation.

Choices:

  • "broadcast"
  • "point_to_point"

passive_participation

string

Enables or disables passive participation in the OSPF Interface Settings.

Defaults to disabled when unset during creation.

Choices:

  • "enabled"
  • "disabled"

priority

integer

The priority of the OSPF Interface Settings.

Defaults to 1 when unset during creation.

The value must be between 0 and 255.

retransmit_interval

integer

The retransmit interval in seconds of the OSPF Interface Settings.

Defaults to 5 when unset during creation.

The value must be between 1 and 65535.

state

string

Use enabled to configure the OSPF Interface Settings.

Use disabled to remove the OSPF Interface Settings.

Choices:

  • "enabled"
  • "disabled"

transmit_delay

integer

The transmit delay in seconds of the OSPF Interface Settings.

Defaults to 1 when unset during creation.

The value must be between 1 and 450.

output_level

string

Influence the output of this MSO module.

normal means the standard output, incl. current dict

info adds informational output, incl. previous, proposed and sent dicts

debug adds debugging output, incl. filter_string, method, response, status and url information

If the value is not specified in the task, the value of environment variable MSO_OUTPUT_LEVEL will be used instead.

Choices:

  • "debug"
  • "info"
  • "normal" ← (default)

password

string

The password to use for authentication.

If the value is not specified in the task, the value of environment variables MSO_PASSWORD or ANSIBLE_NET_PASSWORD will be used instead.

port

integer

Port number to be used for the REST connection.

The default value depends on parameter `use_ssl`.

If the value is not specified in the task, the value of environment variable MSO_PORT will be used instead.

state

string

Use absent for removing.

Use query for listing an object or multiple objects.

Use present for creating or updating.

Choices:

  • "absent"
  • "query" ← (default)
  • "present"

template

string / required

The name of the template.

The template must be a Tenant Policy Template.

timeout

integer

The socket level timeout in seconds.

The default value is 30 seconds.

If the value is not specified in the task, the value of environment variable MSO_TIMEOUT will be used instead.

use_proxy

boolean

If false, it will not use a proxy, even if one is defined in an environment variable on the target hosts.

If the value is not specified in the task, the value of environment variable MSO_USE_PROXY will be used instead.

The default is true.

Choices:

  • false
  • true

use_ssl

boolean

If false, an HTTP connection will be used instead of the default HTTPS connection.

If the value is not specified in the task, the value of environment variable MSO_USE_SSL will be used instead.

When using a HTTPAPI connection plugin the inventory variable ansible_httpapi_use_ssl will be used if this attribute is not specified.

The default is false when using a HTTPAPI connection plugin (mso or nd) and true when using the legacy connection method (only for mso).

Choices:

  • false
  • true

username

string

The username to use for authentication.

If the value is not specified in the task, the value of environment variables MSO_USERNAME or ANSIBLE_NET_USERNAME will be used instead.

uuid

aliases: l3out_interface_routing_policy_uuid

string

The UUID of the L3Out Interface Routing Policy.

This parameter is required when the name needs to be updated.

validate_certs

boolean

If false, SSL certificates will not be validated.

This should only set to false when used on personally controlled sites using self-signed certificates.

If the value is not specified in the task, the value of environment variable MSO_VALIDATE_CERTS will be used instead.

The default is true.

Choices:

  • false
  • true

Notes

Note

  • The template must exist before using this module in your playbook. Use cisco.mso.ndo_template to create the Tenant Policy Template.
  • This module was written to support Multi Site Orchestrator v2.1 or newer. Some or all functionality may not work on earlier versions.

See Also

See also

cisco.mso.ndo_template

Manage Templates on Cisco Nexus Dashboard Orchestrator (NDO).

Examples

- name: Create a new L3Out Interface Routing Policy with default values
  cisco.mso.ndo_l3out_interface_routing_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_tenant_template
    name: irp_1
    bfd_settings:
      state: enabled
    bfd_multi_hop_settings:
      state: enabled
    state: present
  register: irp_1_present

- name: Update an existing L3Out Interface Routing Policy with UUID
  cisco.mso.ndo_l3out_interface_routing_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_tenant_template
    uuid: "{{ irp_1_present.current.uuid }}"
    name: irp_1_updated
    bfd_multi_hop_settings:
      admin_state: disabled
      detection_multiplier: 10
      min_receive_interval: 255
      min_transmit_interval: 255
    bfd_settings:
      admin_state: disabled
      detection_multiplier: 10
      min_receive_interval: 266
      min_transmit_interval: 266
      echo_receive_interval: 60
      echo_admin_state: disabled
      interface_control: enabled
    ospf_interface_settings:
      network_type: point_to_point
      priority: 10
      cost_of_interface: 100
      advertise_subnet: enabled
      bfd: enabled
      mtu_ignore: enabled
      passive_participation: enabled
      hello_interval: 20
      dead_interval: 30
      retransmit_interval: 20
      transmit_delay: 10
    state: present
  register: irp_1_present

- name: Clear an existing L3Out Interface Routing Policy BFD and OSPF interface settings
  cisco.mso.ndo_l3out_interface_routing_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_tenant_template
    uuid: "{{ irp_1_present.current.uuid }}"
    bfd_settings:
      state: disabled
    ospf_interface_settings:
      state: disabled
    state: present

- name: Query an L3Out Interface Routing Policy with name
  cisco.mso.ndo_l3out_interface_routing_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_tenant_template
    name: irp_1_updated
    state: query
  register: query_with_name

- name: Query an L3Out Interface Routing Policy with UUID
  cisco.mso.ndo_l3out_interface_routing_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_tenant_template
    uuid: "{{ irp_1_present.current.uuid }}"
    state: query
  register: query_with_uuid

- name: Query all L3Out Interface Routing Policies
  cisco.mso.ndo_l3out_interface_routing_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_tenant_template
    state: query
  register: query_all

- name: Delete an L3Out Interface Routing Policy
  cisco.mso.ndo_l3out_interface_routing_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_tenant_template
    name: irp_1_updated
    state: absent

- name: Delete an L3Out Interface Routing Policy using UUID
  cisco.mso.ndo_l3out_interface_routing_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_tenant_template
    uuid: "{{ irp_1_present.current.uuid }}"
    state: absent

Authors

  • Sabari Jaganathan (@sajagana)

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/cisco/mso/ndo_l3out_interface_routing_policy_module.html