Модуль cisco.mso.mso_schema_site_vrf_region — управление локальными для сайта регионами VRF в шаблоне схемы

Примечание

Этот модуль входит в коллекцию cisco.mso (версия 2.13.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install cisco.mso. Для использования этого модуля требуются дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: cisco.mso.mso_schema_site_vrf_region.

Краткое описание
Требования
Параметры
Примечания
См. также
Примеры

Краткое описание

Управление локальными для сайта регионами VRF в шаблоне схемы Cisco ACI Multi-Site.

Требования

На хосте, выполняющем этот модуль, должны быть установлены следующие компоненты.

Multi Site Orchestrator версии 2.1 или новее

Параметры

Параметр	Описание
container_overlay boolean	Имя типа профиля контекста. Поддерживается в MSO версии 3.3 и новее. Допустимые значения: `false` `true`
host псевдонимы: hostname string	IP-адрес или имя хоста ACI Multi Site Orchestrator. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `MSO_HOST`.
login_domain string	Имя домена входа для аутентификации. Значение по умолчанию — Local. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `MSO_LOGIN_DOMAIN`. При использовании подключаемого модуля соединения HTTPAPI, если этот атрибут не указан, будет использована переменная инвентаря `ansible_httpapi_login_domain`.
output_level string	Влияет на вывод этого модуля MSO. `normal` означает стандартный вывод, включая словарь `current` `info` добавляет информационные данные, включая словари `previous`, `proposed` и `sent` `debug` добавляет отладочные данные, включая информацию `filter_string`, `method`, `response`, `status` и `url` Если значение не указано в задаче, вместо него будет использовано значение переменной среды `MSO_OUTPUT_LEVEL`. Допустимые значения: `"debug"` `"info"` `"normal"` ← (по умолчанию)
password string	Пароль для аутентификации. Если значение не указано в задаче, вместо него будут использованы значения переменных среды `MSO_PASSWORD` или `ANSIBLE_NET_PASSWORD`.
port integer	Номер порта для REST-соединения. Значение по умолчанию зависит от параметра `use_ssl`. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `MSO_PORT`.
region псевдонимы: name string	Имя региона, которым нужно управлять.
schema string / обязательный	Имя схемы.
site string / обязательный	Имя сайта.
state string	Для добавления или удаления используйте `present` или `absent`. Для получения списка одного или нескольких объектов используйте `query`. Допустимые значения: `"absent"` `"present"` ← (по умолчанию) `"query"`
template string / обязательный	Имя шаблона.
timeout integer	Тайм-аут на уровне сокета в секундах. Значение по умолчанию — 30 секунд. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `MSO_TIMEOUT`.
underlay_context_profile dictionary	Имя типа профиля контекста. Этот параметр можно добавить, только если container_overlay имеет значение True. Поддерживается в MSO версии 3.3 и новее.
region string / обязательный	Имя региона, связанного с VRF профиля контекста underlay.
vrf string / обязательный	Имя VRF, связываемой с профилем контекста underlay.
use_proxy boolean	Если `false`, прокси использоваться не будет, даже если он задан в переменной среды на целевых хостах. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `MSO_USE_PROXY`. Значение по умолчанию: `true`. Допустимые значения: `false` `true`
use_ssl boolean	Если `false`, вместо HTTPS-соединения по умолчанию будет использоваться HTTP-соединение. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `MSO_USE_SSL`. При использовании подключаемого модуля соединения HTTPAPI, если этот атрибут не указан, будет использована переменная инвентаря `ansible_httpapi_use_ssl`. По умолчанию используется `false` при работе с подключаемым модулем соединения HTTPAPI (mso или nd) и `true` при использовании устаревшего метода соединения (только для mso). Допустимые значения: `false` `true`
username string	Имя пользователя для аутентификации. Если значение не указано в задаче, вместо него будут использованы значения переменных среды `MSO_USERNAME` или `ANSIBLE_NET_USERNAME`.
validate_certs boolean	Если `false`, сертификаты SSL не будут проверяться. Устанавливайте значение `false` только на сайтах под личным контролем, использующих самоподписанные сертификаты. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `MSO_VALIDATE_CERTS`. Значение по умолчанию: `true`. Допустимые значения: `false` `true`
vpn_gateway_router boolean	Включен ли маршрутизатор VPN-шлюза. Допустимые значения: `false` `true`
vrf string / обязательный	Имя VRF.

Примечания

Примечание

Из-за ограничений REST API MSO этот модуль не может создавать пустые регионы (то есть регионы без CIDR). Используйте cisco.mso.mso_schema_site_vrf_region_cidr, чтобы автоматически создавать регионы с CIDR.
Этот модуль разработан для поддержки Multi Site Orchestrator версии 2.1 или новее. Некоторые или все функции могут не работать в более ранних версиях.

См. также

cisco.mso.mso_schema_site_vrf: Управление локальными для сайта VRF в шаблоне схемы.
cisco.mso.mso_schema_template_vrf: Управление VRF в шаблонах схем.

Примеры

- name: Remove VPN Gateway Router at site VRF Region
  cisco.mso.mso_schema_site_vrf_region:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    schema: Schema1
    site: Site1
    template: Template1
    vrf: VRF1
    region: us-west-1
    vpn_gateway_router: false
    state: present

- name: Remove a site VRF region
  cisco.mso.mso_schema_site_vrf_region:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    schema: Schema1
    site: Site1
    template: Template1
    vrf: VRF1
    region: us-west-1
    state: absent

- name: Query a specific site VRF region
  cisco.mso.mso_schema_site_vrf_region:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    schema: Schema1
    site: Site1
    template: Template1
    vrf: VRF1
    region: us-west-1
    state: query
  register: query_result

- name: Query all site VRF regions
  cisco.mso.mso_schema_site_vrf_region:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    schema: Schema1
    site: Site1
    template: Template1
    vrf: VRF1
    state: query
  register: query_result

Авторы

Anvitha Jain (@anvitha-jain)
Dag Wieers (@dagwieers)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/cisco/mso/mso_schema_site_vrf_region_module.html