Spec-Zone.ru › Ansible

Модуль cisco.mso.mso_role — управление ролями

Примечание

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

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

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

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

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

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

  • Управление ролями в Cisco ACI Multi-Site.

Требования

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

  • Multi Site Orchestrator v2.1 или новее

Параметры

Параметр

Комментарии

description

string

Описание роли.

display_name

string

Имя роли, отображаемое в веб-интерфейсе.

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.

read_permissions

list / elements=string

Список разрешений на чтение, связанных с этой ролью.

Возможные значения:

  • "backup-db"
  • "manage-audit-records"
  • "manage-labels"
  • "manage-roles"
  • "manage-schemas"
  • "manage-sites"
  • "manage-tenants"
  • "manage-tenant-schemas"
  • "manage-users"
  • "platform-logs"
  • "view-all-audit-records"
  • "view-labels"
  • "view-roles"
  • "view-schemas"
  • "view-sites"
  • "view-tenants"
  • "view-tenant-schemas"
  • "view-users"

role

псевдонимы: name

string

Имя роли.

state

string

Используйте present или absent для добавления или удаления.

Используйте query для вывода одного или нескольких объектов.

Возможные значения:

  • "absent"
  • "present" ← (по умолчанию)
  • "query"

timeout

integer

Тайм-аут на уровне сокета в секундах.

Значение по умолчанию — 30 секунд.

Если значение не указано в задаче, вместо него будет использовано значение переменной окружения MSO_TIMEOUT.

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

write_permissions

псевдонимы: permissions

list / elements=string

Список разрешений на запись, связанных с этой ролью.

Возможные значения:

  • "backup-db"
  • "manage-audit-records"
  • "manage-labels"
  • "manage-roles"
  • "manage-schemas"
  • "manage-sites"
  • "manage-tenants"
  • "manage-tenant-schemas"
  • "manage-users"
  • "platform-logs"
  • "view-all-audit-records"
  • "view-labels"
  • "view-roles"
  • "view-schemas"
  • "view-sites"
  • "view-tenants"
  • "view-tenant-schemas"
  • "view-users"

Примечания

Примечание

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

Примеры

- name: Add a new role
  cisco.mso.mso_role:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    role: readOnly
    display_name: Read Only
    description: Read-only access for troubleshooting
    read_permissions:
      - view-roles
      - view-schemas
      - view-sites
      - view-tenants
      - view-tenant-schemas
      - view-users
    write_permissions:
      - manage-roles
      - manage-schemas
      - manage-sites
      - manage-tenants
      - manage-tenant-schemas
      - manage-users
    state: present

- name: Remove a role
  cisco.mso.mso_role:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    role: readOnly
    state: absent

- name: Query a role
  cisco.mso.mso_role:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    role: readOnly
    state: query
  register: query_result

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

Авторы

  • 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_role_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API