cisco.mso.ndo_l3out_interface_group_policy module – Manage L3Out Interface Group Policy 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_group_policy.

Synopsis

  • Manage L3Out Interface Group Policy 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

dictionary

The Bidirectional Forwarding Detection (BFD) configuration.

Providing an empty dictionary will remove the bfd={} from the L3Out Interface Group Policy.

authentication

boolean

Whether BFD authentication is enabled.

Choices:

  • false

  • true

enable

boolean

Whether BFD is enabled.

Choices:

  • false

  • true

key

string

The BFD key.

key_id

integer

The BFD key ID.

bfd_multi_hop

dictionary

The Bidirectional Forwarding Detection (BFD) multi-hop configuration.

Providing an empty dictionary will remove the bfd_multi_hop={} from the L3Out Interface Group Policy.

authentication

boolean

Whether BFD multi-hop authentication is enabled.

Choices:

  • false

  • true

enable

boolean

Whether BFD multi-hop is enabled.

Choices:

  • false

  • true

key

string

The BFD multi-hop key.

key_id

integer

The BFD multi-hop key ID.

custom_qos_policy

dictionary

The Custom QoS Policy configuration.

Providing an empty dictionary will remove the custom_qos_policy={} from L3Out Interface Group Policy.

name

string

The name of the Custom QoS Policy.

template

string

The template associated with the Custom QoS Policy.

This parameter or custom_qos_policy.template_id is required.

template_id

string

The template ID associated with the the Custom QoS Policy.

This parameter or custom_qos_policy.template is required.

custom_qos_policy_uuid

string

The UUID of the Custom QoS Policy.

Providing an empty string will remove the custom_qos_policy_uuid="" from L3Out Interface Group Policy.

description

string

The description of the L3Out Interface Group 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.

interface_routing_policy

dictionary

The configuration of the Interface Routing Policy.

Providing an empty dictionary will remove the interface_routing_policy={} from L3Out Interface Group Policy.

name

string

The name of the L3Out Interface Routing Policy.

template

string

The template associated with the L3Out Interface Routing Policy.

This parameter or interface_routing_policy.template_id is required.

template_id

string

The template ID associated with the L3Out Interface Routing Policy.

This parameter or interface_routing_policy.template is required.

interface_routing_policy_uuid

string

The UUID of the L3Out Interface Routing Policy.

Providing an empty string will remove the interface_routing_policy_uuid="" from L3Out Interface Group Policy.

l3out

aliases: l3out_name

string

The name of the L3Out.

This parameter or l3out_uuid is required.

l3out_uuid

string

The UUID of the L3Out.

This parameter or l3out is required.

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_group_policy

string

The name of the L3Out Interface Group Policy.

ospf

dictionary

The Open Shortest Path First (OSPF) configuration.

Providing an empty dictionary will remove the ospf={} from the L3Out Interface Group Policy.

authentication_type

string

The type of OSPF authentication.

Choices:

  • "simple"

  • "md5"

  • "none"

enable

boolean

Whether OSPF is enabled.

Choices:

  • false

  • true

key

string

The OSPF key.

key_id

integer

The OSPF key ID.

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.

qos_priority

string

The QoS priority level.

Choices:

  • "level1"

  • "level2"

  • "level3"

  • "level4"

  • "level5"

  • "level6"

  • "unspecified"

state

string

Determines the desired state of the resource.

Use absent to remove the resource.

Use query to list the resource.

Use present to create or update the resource.

Choices:

  • "absent"

  • "query" ← (default)

  • "present"

template

aliases: l3out_template

string

The name of the template.

The template must be an L3Out template.

This parameter or template_id is required.

template_id

aliases: l3out_template_id

string

The ID of the L3Out template.

This parameter or template is required.

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.

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

See Also

See also

cisco.mso.ndo_template

Manage Templates on Cisco Nexus Dashboard Orchestrator (NDO).

cisco.mso.ndo_l3out_template

Manage L3Outs on Cisco Nexus Dashboard Orchestrator (NDO).

cisco.mso.ndo_l3out_interface_routing_policy

Manage L3Out Interface Routing Policies on Cisco Nexus Dashboard Orchestrator (NDO).

cisco.mso.ndo_tenant_custom_qos_policy

Manage Custom QoS Policies in Tenant Policy Templates on Cisco Nexus Dashboard Orchestrator (NDO).

Examples

- name: Create an L3Out interface group policy
  cisco.mso.ndo_l3out_interface_group_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: l3out_template
    l3out: l3out
    name: interface_group_policy_1
    description: Test description
    interface_routing_policy:
      name: ansible_l3out_interface_routing_policy
      template: ansible_tenant_template
    bfd:
      enable: true
      authentication: true
      key_id: 1
      key: TestKey
    bfd_multi_hop:
      enable: true
      authentication: true
      key_id: 1
      key: TestKey
    ospf:
      enable: true
      authentication_type: simple
      key_id: 1
      key: TestKey
    custom_qos_policy:
      template: ansible_tenant_template
      name: ansible_custom_qos_policy
    qos_priority: level1
    state: present

- name: Query an existing L3Out interface group policy with name
  cisco.mso.ndo_l3out_interface_group_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: l3out_template
    l3out: l3out
    name: interface_group_policy_1
    state: query
  register: query_with_name

- name: Query all existing L3Out interface group policies under l3out
  cisco.mso.ndo_l3out_interface_group_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: l3out_template
    l3out: l3out
    state: query

- name: Delete an existing L3Out interface group policy with name
  cisco.mso.ndo_l3out_interface_group_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: l3out_template
    l3out: l3out
    name: interface_group_policy_1
    state: absent

Authors

  • Shreyas Srish (@shrsr)