W3cubDocs

/Ansible

cisco.mso.ndo_tenant_bgp_peer_prefix_policy module – Manage BGP Peer Prefix Policies in Tenant Policy Templates 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_tenant_bgp_peer_prefix_policy.

Synopsis

  • Manage BGP Peer Prefix Policies in Tenant Policy Templates 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

action

string

The action of the BGP Peer Prefix Policy.

The default value is reject.

Choices:

  • "log"
  • "reject"
  • "restart"
  • "shutdown"

description

string

The description of the BGP Peer Prefix Policy.

Providing an empty string will remove the description="" from the BGP Peer Prefix 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.

max_number_of_prefixes

aliases: max_prefix, max

integer

The maximum number of prefixes for the BGP Peer Prefix Policy.

The value must be between 1 and 300000.

The default value is 20000 prefixes.

name

aliases: bgp_peer_prefix_policy

string

The name of the BGP Peer Prefix 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.

restart_time

aliases: restart

integer

The restart time of the BGP Peer Prefix Policy in seconds.

The value must be between 1 and 65535.

The default value is 1 second.

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

aliases: tenant_template

string / required

The name of the tenant template.

threshold_percentage

aliases: threshold

integer

The threshold percentage of the BGP Peer Prefix Policy.

The value must be between 1 and 100.

The default value is 75%.

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

string

The UUID of the BGP Peer Prefix Policy.

This parameter is required when the BGP Peer Prefix Policy 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 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 BGP Peer Prefix Policy object
  cisco.mso.ndo_tenant_bgp_peer_prefix_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: tenant_template
    name: bgp_peer_prefix_policy_1
    action: restart
    max_number_of_prefixes: 1000
    threshold_percentage: 50
    restart_time: 60
    state: present
  register: bgp_peer_prefix_policy_1

- name: Update a BGP Peer Prefix Policy object name with UUID
  cisco.mso.ndo_tenant_bgp_peer_prefix_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: tenant_template
    name: bgp_peer_prefix_policy_2
    uuid: "{{ bgp_peer_prefix_policy_1.current.uuid }}"
    state: present

- name: Query a BGP Peer Prefix Policy object with name
  cisco.mso.ndo_tenant_bgp_peer_prefix_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: tenant_template
    name: bgp_peer_prefix_policy_1
    state: query
  register: query_uuid

- name: Query a BGP Peer Prefix Policy object with UUID
  cisco.mso.ndo_tenant_bgp_peer_prefix_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: tenant_template
    uuid: "{{ bgp_peer_prefix_policy_1.current.uuid }}"
    state: query
  register: query_uuid

- name: Query all BGP Peer Prefix Policy objects in a Tenant Template
  cisco.mso.ndo_tenant_bgp_peer_prefix_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: tenant_template
    state: query
  register: query_all

- name: Delete a BGP Peer Prefix Policy object with name
  cisco.mso.ndo_tenant_bgp_peer_prefix_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: tenant_template
    name: bgp_peer_prefix_policy_1
    state: absent

- name: Delete a BGP Peer Prefix Policy object with UUID
  cisco.mso.ndo_tenant_bgp_peer_prefix_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: tenant_template
    uuid: "{{ bgp_peer_prefix_policy_1.current.uuid }}"
    state: absent

Authors

  • Akini Ross (@akinross)

© 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_tenant_bgp_peer_prefix_policy_module.html