netapp.ontap.na_ontap_rest_info – Сборщик информации о NetApp ONTAP с использованием REST API

Примечание

Этот плагин входит в состав коллекции netapp.ontap (версия 21.1.1).

Для его установки используйте: ansible-galaxy collection install netapp.ontap.

Чтобы использовать его в книге задач, укажите: netapp.ontap.na_ontap_rest_info.

Новое в версии 20.5.0: of netapp.ontap

Обзор
Требования
Параметры
Примечания
Примеры

Обзор

Этот модуль позволяет собирать различную информацию о конфигурации ONTAP с использованием REST API

Требования

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

Ansible 2.9
Python3 netapp-lib (2018.11.13) или более поздняя версия. Установите с помощью ‘pip install netapp-lib’
netapp-lib 2020.3.12 настоятельно рекомендуется, так как он обеспечивает более подробные сообщения об ошибках для проблем с подключением.
Физическая или виртуальная кластеризованная система Data ONTAP. Модули поддерживают Data ONTAP 9.1 и более поздние версии.
Поддержка REST требует ONTAP 9.6 или более поздней версии.
Чтобы включить http в кластере, необходимо выполнить следующие команды: ‘set -privilege advanced;’ ‘system services web modify -http-enabled true;’

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
cert_filepath строка добавлено в 20.6.0 of netapp.ontap		путь к файлу SSL-сертификата клиента (.pem). не поддерживается с Python 2.6.
feature_flags словарь добавлено в 20.5.0 of netapp.ontap		Включить или отключить новую функцию. Это можно использовать для включения экспериментальной функции или отключения новой функции, которая нарушает обратную совместимость. Поддерживаемые ключи и значения могут быть изменены без предварительного уведомления. Неизвестные ключи игнорируются.
fields список / элементы=строка добавлено в 20.6.0 of netapp.ontap		Запрос определенных полей из подмножества. «*» для возврата всех полей, разрешено одно или несколько подмножеств. «<список полей>» для возврата указанных полей, разрешено только одно подмножество. Если опция отсутствует, возвращаются все поля.
gather_subset список / элементы=строка	По умолчанию: "all"	При указании этот аргумент ограничит собираемую информацию заданным подмножеством. Можно указать имя информации или REST API. Возможные значения для этого аргумента включают "aggregate_info" или "storage/aggregates", "application_info" или "application/applications", "application_template_info" или "application/templates", "autosupport_config_info" или "support/autosupport", "autosupport_messages_history" или "support/autosupport/messages", "broadcast_domains_info" или "network/ethernet/broadcast-domains", "cifs_home_directory_info" или "protocols/cifs/home-directory/search-paths", "cifs_services_info" или "protocols/cifs/services", "cifs_share_info" или "protocols/cifs/shares", "cloud_targets_info" или "cloud/targets", "cluster_chassis_info" или "cluster/chassis", "cluster_jobs_info" или "cluster/jobs", "cluster_metrics_info" или "cluster/metrics", "cluster_node_info" или "cluster/nodes", "cluster_peer_info" или "cluster/peers", "cluster_schedules" или "cluster/schedules", "cluster_software_download" или "cluster/software/download", "cluster_software_history" или "cluster/software/history", "cluster_software_packages" или "cluster/software/packages", "disk_info" или "storage/disks", "event_notification_info" или "support/ems/destinations", "event_notification_destination_info" или "support/ems/destinations", "initiator_groups_info" или "protocols/san/igroups", "ip_interfaces_info" или "network/ip/interfaces", "ip_routes_info" или "network/ip/routes", "ip_service_policies" или "network/ip/service-policies", "network_ipspaces_info" или "network/ipspaces", "network_ports_info" или "network/ethernet/ports", "ontap_system_version" или "cluster/software", "san_fc_logins_info" или "network/fc/logins", "san_fc_wppn-aliases" или "network/fc/wwpn-aliases", "san_fcp_services" или "protocols/san/fcp/services", "san_iscsi_credentials" или "protocols/san/iscsi/credentials", "san_iscsi_services" или "protocols/san/iscsi/services", "san_lun_maps" или "protocols/san/lun-maps", "security_login_info" или "security/accounts", "security_login_rest_role_info" или "security/roles", "storage_flexcaches_info" или "storage/flexcache/flexcaches", "storage_flexcaches_origin_info" или "storage/flexcache/origins", "storage_luns_info" или "storage/luns", "storage_NVMe_namespaces" или "storage/namespaces", "storage_ports_info" или "storage/ports", "storage_qos_policies" или "storage/qos/policies", "storage_qtrees_config" или "storage/qtrees", "storage_quota_reports" или "storage/quota/reports", "storage_quota_policy_rules" или "storage/quota/rules", "storage_shelves_config" или "storage/shelves", "storage_snapshot_policies" или "storage/snapshot-policies", "support_ems_config" или "support/ems", "support_ems_events" или "support/ems/events", "support_ems_filters" или "support/ems/filters", "svm_dns_config_info" или "name-services/dns", "svm_ldap_config_info" или "name-services/ldap", "svm_name_mapping_config_info" или "name-services/name-mappings", "svm_nis_config_info" или "name-services/nis", "svm_peers_info" или "svm/peers", "svm_peer-permissions_info" или "svm/peer-permissions", "vserver_info" или "svm/svms", "volume_info" или "storage/volumes", Можно указать список значений для включения большего подмножества. REST API поддерживаются с ONTAP 9.6 и более поздними версиями.
hostname строка / обязательно		Имя хоста или IP-адрес экземпляра ONTAP.
http_port целое число		Переопределить порт по умолчанию (80 или 443) этим портом
https логическое значение	Варианты: нет ← да	Включить и отключить https. Игнорируется при использовании REST, так как поддерживается только https. Игнорируется при использовании аутентификации по SSL-сертификату, так как требуется SSL.
key_filepath строка добавлено в 20.6.0 of netapp.ontap		путь к файлу закрытого ключа SSL-клиента.
max_records целое число	По умолчанию: 1024	Максимальное количество записей, возвращаемых за один вызов.
ontapi целое число		Версия API ontap для использования
parameters словарь добавлено в 20.7.0 of netapp.ontap		Позволяет передавать любые параметры rest.
password строка		Пароль для указанного пользователя. псевдонимы: pass
state строка		устарел начиная с 21.1.0. Этот параметр игнорировался и по-прежнему игнорируется.
use_rest строка	По умолчанию: "auto"	REST API, если это поддерживается целевой системой для всех ресурсов и атрибутов, необходимых модулю. В противном случае возвращается к ZAPI. всегда -- всегда использовать REST API никогда -- всегда использовать ZAPI авто -- попытаться использовать REST API
username строка		Это может быть учетная запись на уровне кластера или SVM, в зависимости от того, требуется ли API на уровне кластера или SVM. Для получения дополнительной информации ознакомьтесь с документацией https://mysupport.netapp.com/NOW/download/software/nmsdk/9.4/. Поддерживаются два метода аутентификации 1. аутентификация по основанию, используя имя пользователя и пароль, 2. аутентификация по SSL-сертификату, используя файл SSL-сертификата клиента и, необязательно, файл закрытого ключа. Для использования сертификата сертификат должен быть установлен в кластере ONTAP, и должна быть включена аутентификация по сертификатам. псевдонимы: user
validate_certs логическое значение	Варианты: нет да ←	Если значение равно `no`, SSL-сертификаты не будут проверены. Это значение следует устанавливать только в `False` для сайтов под собственным контролем, использующих самозаверяемые сертификаты.

Примечания

Примечание

Модули с префиксом na\_ontap созданы для поддержки платформы хранения ONTAP.

Примеры

- name: run ONTAP gather facts for vserver info
  na_ontap_info_rest:
      hostname: "1.2.3.4"
      username: "testuser"
      password: "test-password"
      https: true
      validate_certs: false
      use_rest: Always
      gather_subset:
      - vserver_info
- name: run ONTAP gather facts for aggregate info and volume info
  na_ontap_info_rest:
      hostname: "1.2.3.4"
      username: "testuser"
      password: "test-password"
      https: true
      validate_certs: false
      use_rest: Always
      gather_subset:
      - aggregate_info
      - volume_info
- name: run ONTAP gather facts for all subsets
  na_ontap_info_rest:
      hostname: "1.2.3.4"
      username: "testuser"
      password: "test-password"
      https: true
      validate_certs: false
      use_rest: Always
      gather_subset:
      - all
- name: run ONTAP gather facts for aggregate info and volume info with fields section
  na_ontap_info_rest:
      hostname: "1.2.3.4"
      username: "testuser"
      password: "test-password"
      https: true
      fields:
      - '*'
      validate_certs: false
      use_rest: Always
      gather_subset:
      - aggregate_info
      - volume_info
- name: run ONTAP gather facts for aggregate info with specified fields
  na_ontap_info_rest:
      hostname: "1.2.3.4"
      username: "testuser"
      password: "test-password"
      https: true
      fields:
      - 'uuid'
      - 'name'
      - 'node'
      validate_certs: false
      use_rest: Always
      gather_subset:
      - aggregate_info

Авторы

Команда NetApp Ansible (@carchi8py) <ng-ansibleteam@netapp.com>

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/netapp/ontap/na_ontap_rest_info_module.html