mso_schema_template_anp_epg_subnet – Manage EPG subnets in schema templates

mso_schema_template_anp_epg_subnet – Manage EPG subnets in schema templates

New in version 2.8.

• Synopsis
• Requirements
• Parameters
• Notes
• Examples
• Status

Synopsis

• Manage EPG subnets in schema templates on Cisco ACI Multi-Site.

Requirements

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

• Multi Site Orchestrator v2.1 or newer

Parameters

Parameter	Choices/Defaults	Comments
anp string / required		The name of the ANP.
description string		The description of this subnet.
epg string / required		The name of the EPG to manage.
host string / required		IP Address or hostname of the ACI Multi Site Orchestrator host. aliases: hostname
no_default_gateway boolean	no yes	Whether this subnet has a default gateway.
output_level string	debug info normal ←	Influence the output of this ACI 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
password string / required		The password to use for authentication. This option is mutual exclusive with private_key. If private_key is provided too, it will be used instead.
port integer		Port number to be used for the REST connection. The default value depends on parameter `use_ssl`.
schema string / required		The name of the schema.
scope string	private public	The scope of the subnet.
shared boolean	no yes	Whether this subnet is shared between VRFs.
state string	absent present ← query	Use present or absent for adding or removing. Use query for listing an object or multiple objects.
subnet string / required		The IP range in CIDR notation. aliases: ip
template string / required		The name of the template to change.
timeout integer	Default: 30	The socket level timeout in seconds.
use_proxy boolean	no yes ←	If no, it will not use a proxy, even if one is defined in an environment variable on the target hosts.
use_ssl boolean	no yes ←	If no, an HTTP connection will be used instead of the default HTTPS connection.
username string	Default: "admin"	The username to use for authentication.
validate_certs boolean	no yes ←	If no, SSL certificates will not be validated. This should only set to no when used on personally controlled sites using self-signed certificates.

Notes

Note

• Due to restrictions of the MSO REST API concurrent modifications to EPG subnets can be dangerous and corrupt data.
• Please read the Cisco ACI Guide for more detailed information on how to manage your ACI infrastructure using Ansible.
• This module was written to support ACI Multi Site Orchestrator v2.1 or newer. Some or all functionality may not work on earlier versions.

Examples

- name: Add a new subnet to an EPG
  mso_schema_template_anp_epg_subnet:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    schema: Schema 1
    template: Template 1
    anp: ANP 1
    epg: EPG 1
    subnet: 10.0.0.0/24
    state: present
  delegate_to: localhost

- name: Remove a subnet from an EPG
  mso_schema_template_anp_epg_subnet:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    schema: Schema 1
    template: Template 1
    anp: ANP 1
    epg: EPG 1
    subnet: 10.0.0.0/24
    state: absent
  delegate_to: localhost

- name: Query a specific EPG subnet
  mso_schema_template_anp_epg_subnet:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    schema: Schema 1
    template: Template 1
    anp: ANP 1
    epg: EPG 1
    subnet: 10.0.0.0/24
    state: query
  delegate_to: localhost
  register: query_result

- name: Query all EPGs subnets
  mso_schema_template_anp_epg_subnet:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    schema: Schema 1
    template: Template 1
    anp: ANP 1
    state: query
  delegate_to: localhost
  register: query_result

Status

• This module is not guaranteed to have a backwards compatible interface. [preview]
• This module is maintained by the Ansible Community. [community]

Authors

• Dag Wieers (@dagwieers)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/mso_schema_template_anp_epg_subnet_module.html