mso_schema_template_vrf – Manage VRFs in schema templates — Ansible Documentation

- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# mso_schema_template_vrf – Manage VRFs in schema templates

New in version 2.8.

- Synopsis
- Requirements
- Parameters
- Notes
- Examples
- Status

## Synopsis

- Manage VRFs 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
--- | --- | ---
display_name string |  | The name as displayed on the MSO web interface.
host string / required |  | IP Address or hostname of the ACI Multi Site Orchestrator host. aliases: hostname
layer3_multicast boolean | Choices: no yes | Whether to enable L3 multicast.
output_level string | Choices: 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.
state string | Choices: absent present ← query | Use `present` or `absent` for adding or removing. Use `query` for listing an object or multiple objects.
template string / required |  | The name of the template.
timeout integer | Default: 30 | The socket level timeout in seconds.
use_proxy boolean | Choices: 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 | Choices: 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 | Choices: 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.
vrf string |  | The name of the VRF to manage. aliases: name

## Notes

Note

- 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 VRF
      mso_schema_template_vrf:
        host: mso_host
        username: admin
        password: SomeSecretPassword
        schema: Schema 1
        template: Template 1
        vrf: VRF 1
        state: present
      delegate_to: localhost

    - name: Remove an VRF
      mso_schema_template_vrf:
        host: mso_host
        username: admin
        password: SomeSecretPassword
        schema: Schema 1
        template: Template 1
        vrf: VRF1
        state: absent
      delegate_to: localhost

    - name: Query a specific VRFs
      mso_schema_template_vrf:
        host: mso_host
        username: admin
        password: SomeSecretPassword
        schema: Schema 1
        template: Template 1
        vrf: VRF1
        state: query
      delegate_to: localhost
      register: query_result

    - name: Query all VRFs
      mso_schema_template_vrf:
        host: mso_host
        username: admin
        password: SomeSecretPassword
        schema: Schema 1
        template: Template 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.