Модуль purestorage.flasharray.purefa_apiclient — управление клиентами API FlashArray

Примечание

Этот модуль входит в коллекцию purestorage.flasharray (версия 1.42.0).

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

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

Чтобы использовать модуль в сценарии, укажите: purestorage.flasharray.purefa_apiclient.

Добавлено в purestorage.flasharray 1.5.0

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

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

Включение или отключение клиентов API FlashArray

Требования

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

python >= 3.3
purestorage >= 1.19
py-pure-client >= 1.26.0
netaddr
requests
pycountry
urllib3

Параметры

Параметр	Комментарии
api_token string	Токен API FlashArray для пользователя с правами администратора.
disable_warnings boolean добавлено в purestorage.flasharray 1.29.0	Отключить предупреждения о небезопасных сертификатах в журналах отладки Варианты: `false` ← (по умолчанию) `true`
enabled boolean	Состояние ключа клиента API Варианты: `false` `true` ← (по умолчанию)
fa_url string	IPv4-адрес или имя хоста для управления FlashArray.
issuer string	Имя поставщика удостоверений, который будет выдавать токены ID для этого клиента API Если значение не указано, по умолчанию используется имя клиента API — name.
name string / обязательный	Имя клиента API
public_key string	Открытый ключ RSA клиента API в формате PEM (кодировка Base64). Добавьте строки —–BEGIN PUBLIC KEY—– и —–END PUBLIC KEY—–
role string	Максимальная роль, разрешённая для токенов ID, выдаваемых этим клиентом API Варианты: `"readonly"` `"ops_admin"` `"storage_admin"` `"array_admin"`
state string	Определяет, должен ли клиент API существовать. Варианты: `"absent"` `"present"` ← (по умолчанию)
token_ttl integer	Время жизни (в секундах) обменённого токена доступа Допустимый диапазон: от 1 секунды до 1 дня (86400 секунд) По умолчанию: `86400`

Примечания

Примечание

Для работы этого модуля требуются библиотеки Python purestorage и py-pure-client.
Для отдельных модулей могут потребоваться дополнительные библиотеки Python.
Если аргументы fa_url и api_token не передаются непосредственно модулю, необходимо задать переменные окружения PUREFA_URL и PUREFA_API.

Примеры

- name: Create API token ansible-token
  purestorage.flasharray.purefa_apiclient:
    name: ansible-token
    issuer: "Pure Storage"
    token_ttl: 3000
    role: array_admin
    public_key: "{{lookup('file', 'public_pem_file') }}"
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

- name: Disable API CLient
  purestorage.flasharray.purefa_apiclient:
    name: ansible-token
    enabled: false
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

- name: Enable API CLient
  purestorage.flasharray.purefa_apiclient:
    name: ansible-token
    enabled: true
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

- name: Delete API Client
  purestorage.flasharray.purefa_apiclient:
    state: absent
    name: ansible-token
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

Авторы

Команда Ansible Pure Storage (@sdodsley)

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

© 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/purestorage/flasharray/purefa_apiclient_module.html