W3cubDocs

/Ansible

cisco.mso.ndo_l3out_node_routing_policy module – Manage L3Out Node 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_node_routing_policy.

Synopsis

  • Manage L3Out Node 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

as_path_multipath_relax

string

The BGP Best Path Control of the L3Out Node Routing Policy.

Providing an empty string will remove the as_path_multipath_relax="" from the L3Out Node Routing Policy.

Choices:

  • "enabled"
  • "disabled"
  • ""

bfd_multi_hop_settings

dictionary

The BFD MultiHop Settings configuration of the L3Out Node 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"

bgp_node_settings

dictionary

The BGP Node Settings configuration of the L3Out Node Routing Policy.

graceful_restart_helper

string

The graceful restart helper of the BGP Node Settings.

Defaults to enabled when unset during creation.

Choices:

  • "enabled"
  • "disabled"

hold_interval

integer

The hold interval of the BGP Node Settings.

Defaults to 180 when unset during creation.

The value must be 0 or between 3 and 3600 seconds.

keep_alive_interval

integer

The keep alive interval of the BGP Node Settings.

Defaults to 60 when unset during creation.

The value must be between 0 and 3600 seconds.

max_as_limit

integer

The max as limit of the BGP Node Settings.

Defaults to 0 when unset during creation.

The value must be between 0 and 2000.

stale_interval

integer

The stale interval of the BGP Node Settings.

Defaults to 300 when unset during creation.

The value must be between 1 and 3600 seconds.

state

string

Use enabled to configure the BGP Node Settings.

Use disabled to remove the BGP Node Settings.

Choices:

  • "enabled"
  • "disabled"

description

string

The description of the L3Out Node 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_node_routing_policy_name

string

The name of the L3Out Node Routing Policy.

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_node_routing_policy_uuid

string

The UUID of the L3Out Node 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 Node Routing Policy with empty bgp_node and bfd_multi_hop settings
  cisco.mso.ndo_l3out_node_routing_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_tenant_template
    name: nrp_1
    bfd_multi_hop_settings:
      state: enabled
    bgp_node_settings:
      state: enabled
    as_path_multipath_relax: disabled
    state: present

- name: Create a new L3Out Node Routing Policy with full config of bgp_node and bfd_multi_hop settings
  cisco.mso.ndo_l3out_node_routing_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_tenant_template
    name: nrp_2
    bfd_multi_hop_settings:
      admin_state: enabled
      detection_multiplier: 10
      min_receive_interval: 450
      min_transmit_interval: 550
    bgp_node_settings:
      graceful_restart_helper: enabled
      keep_alive_interval: 15
      hold_interval: 115
      stale_interval: 215
      max_as_limit: 25
    as_path_multipath_relax: disabled
    state: present
  register: nrp_2

- name: Update L3Out Node Routing Policy name and bgp_node_settings attributes
  cisco.mso.ndo_l3out_node_routing_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_tenant_template
    uuid: "{{ nrp_2.current.uuid }}"
    name: nrp_2_updated
    bgp_node_settings:
      graceful_restart_helper: disabled
      keep_alive_interval: 20
    state: present

- name: Query a L3Out Node Routing Policies with name
  cisco.mso.ndo_l3out_node_routing_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_tenant_template
    name: nrp_1
    state: query
  register: query_with_name

- name: Query a L3Out Node Routing Policies with UUID
  cisco.mso.ndo_l3out_node_routing_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_tenant_template
    uuid: "{{ query_with_name.current.uuid }}"
    state: query
  register: query_with_uuid

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

- name: Delete a L3Out Node Routing Policy
  cisco.mso.ndo_l3out_node_routing_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_tenant_template
    name: nrp_1
    state: absent

- name: Delete a L3Out Node Routing Policy using UUID
  cisco.mso.ndo_l3out_node_routing_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_tenant_template
    uuid: "{{ query_with_name.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_node_routing_policy_module.html