Модуль cisco.mso.mso_label – Управление метками

Примечание

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

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

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

Для использования в playbook укажите: cisco.mso.mso_label.

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

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

Управление метками в Cisco ACI Multi-Site.

Требования

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

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

Параметры

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

Примечания

Примечание

Этот модуль был написан для поддержки Multi Site Orchestrator версии 2.1 или новее. Некоторые или все функции могут не работать в более ранних версиях.

Примеры

- name: Add a new label
  cisco.mso.mso_label:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    label: Belgium
    type: site
    state: present

- name: Remove a label
  cisco.mso.mso_label:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    label: Belgium
    state: absent

- name: Query a label
  cisco.mso.mso_label:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    label: Belgium
    state: query
  register: query_result

- name: Query all labels
  cisco.mso.mso_label:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    state: query
  register: query_result

Авторы

Dag Wieers (@dagwieers)

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

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