Модуль netapp.ontap.na_ontap_rest_info — сбор сведений о NetApp ONTAP с помощью REST API

Примечание

Этот модуль входит в коллекцию netapp.ontap (версия 23.5.0).

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

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

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

Добавлено в netapp.ontap 20.5.0

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

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

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

Требования

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

Ansible 2.9 или более поздней версии; рекомендуется версия 2.12 или более поздняя.
Python 3; рекомендуется версия 3.9 или более поздняя.
netapp-lib — только при использовании ZAPI (установите с помощью «pip install netapp-lib»). Обратите внимание: netapp-lib объявлена устаревшей и больше не поддерживается. Используйте её на свой страх и риск.
Физическая или виртуальная кластерная система Data ONTAP. Модули поддерживают Data ONTAP 9.1 и более поздние версии; для поддержки REST требуется ONTAP 9.6 или более поздняя версия.

Параметры

Параметр	Комментарии
cert_filepath строка добавлено в netapp.ontap 20.6.0	Путь к файлу сертификата клиента SSL (.pem). Не поддерживается в Python 2.6.
feature_flags словарь добавлено в netapp.ontap 20.5.0	Включение или отключение новой функции. Этот параметр можно использовать для включения экспериментальной функции или отключения новой функции, нарушающей обратную совместимость. Поддерживаемые ключи и значения могут изменяться без уведомления. Неизвестные ключи игнорируются.
fields список / элементы=строка добавлено в netapp.ontap 20.6.0	Запросить определённые поля подмножества. Рекомендуется — «<список полей>», чтобы вернуть указанные поля; допускается только одно подмножество. Не рекомендуется — «», чтобы вернуть все поля; допускается одно или несколько подмножеств. Этот параметр можно использовать для поиска, но не рекомендуется использовать в рабочей среде. Настоятельно не рекомендуется — «», чтобы вернуть все поля; допускается одно или несколько подмножеств. Этот параметр может создать дополнительную нагрузку на систему и не должен использоваться в рабочей среде. Ограниченный вариант — «», чтобы вернуть поля по умолчанию, обычно свойства, уникально идентифицирующие запись (ключи). Остальные данные по умолчанию не возвращаются; для их получения необходимо явно указать имя поля или . Если параметр не указан, возвращаются поля по умолчанию для этого API (см. описание «» выше).
force_ontap_version строка добавлено в netapp.ontap 21.23.0	Переопределяет версию ONTAP кластера при использовании REST. Если указанная версия не соответствует целевому кластеру, поведение не определено. Этот параметр предусмотрен как обходное решение, если из-за проблем с разрешениями не удаётся прочитать версию кластера. См. https://github.com/ansible-collections/netapp.ontap/wiki/Known-issues. Значение должно иметь формат 9.10 или 9.10.1; каждый элемент должен быть целым числом.
gather_subset список / элементы=строка	Если этот аргумент указан, он ограничивает сбор сведений заданным подмножеством. Можно указать REST API или имя информационного объекта ZAPI. Возможные значения этого аргумента: application/applications или application_info application/consistency-groups application/consistency-groups/metrics Требуется указать owning_resource application/consistency-groups/snapshots Требуется указать owning_resource application/templates или application_template_info cloud/targets или cloud_targets_info cluster cluster/chassis или cluster_chassis_info cluster/counter/tables cluster/firmware/history cluster/jobs или cluster_jobs_info cluster/licensing/capacity-pools cluster/licensing/license-managers cluster/licensing/licenses или license_info cluster/mediators cluster/metrics или cluster_metrics_info cluster/metrocluster или metrocluster_info cluster/metrocluster/diagnostics или cluster_metrocluster_diagnostics или metrocluster_check_info cluster/metrocluster/dr-groups cluster/metrocluster/interconnects cluster/metrocluster/nodes или metrocluster-node-get-iter cluster/metrocluster/operations cluster/metrocluster/svms cluster/nodes или cluster_node_info или sysconfig_info cluster/ntp/keys cluster/ntp/servers или ntp_server_info cluster/peers или cluster_peer_info cluster/schedules или cluster_schedules или job_schedule_cron_info cluster/sensors cluster/software или ontap_system_version или cluster_image_info cluster/software/download или cluster_software_download cluster/software/history или cluster_software_history cluster/software/packages или cluster_software_packages cluster/web name-services/cache/group-membership/settings name-services/cache/host/settings name-services/cache/netgroup/settings name-services/cache/setting name-services/cache/unix-group/settings name-services/dns или svm_dns_config_info или net_dns_info name-services/ldap или svm_ldap_config_info или ldap_client или ldap_config name-services/ldap-schemas name-services/local-hosts name-services/name-mappings или svm_name_mapping_config_info name-services/nis или svm_nis_config_info name-services/unix-groups name-services/unix-users network/ethernet/broadcast-domains или broadcast_domains_info или net_port_broadcast_domain_info network/ethernet/ports или network_ports_info или net_port_info network/ethernet/switch/ports network/ethernet/switches или cluster_switch_info network/fc/fabrics network/fc/interfaces network/fc/logins или san_fc_logins_info network/fc/ports network/fc/wwpn-aliases или san_fc_wppn-aliases или fcp_alias_info network/http-proxy network/ip/bgp/peer-groups network/ip/interfaces или ip_interfaces_info или net_interface_info network/ip/routes или ip_routes_info или net_routes_info network/ip/service-policies или ip_service_policies или net_interface_service_policy_info network/ip/subnets network/ipspaces или network_ipspaces_info или net_ipspaces_info private/support/alerts или sys_cluster_alerts private/cli/vserver/security/file-directory или file_directory_security protocols/active-directory protocols/audit protocols/cifs/connections protocols/cifs/domains protocols/cifs/group-policies protocols/cifs/home-directory/search-paths или cifs_home_directory_info protocols/cifs/local-groups protocols/cifs/local-users protocols/cifs/netbios protocols/cifs/services или cifs_services_info или cifs_options_info protocols/cifs/session/files protocols/cifs/sessions protocols/cifs/shadow-copies protocols/cifs/shadowcopy-sets protocols/cifs/shares или cifs_share_info protocols/cifs/users-and-groups/privileges protocols/cifs/unix-symlink-mapping protocols/fpolicy protocols/locks protocols/ndmp protocols/ndmp/nodes protocols/ndmp/sessions protocols/ndmp/svms protocols/nfs/connected-clients protocols/nfs/connected-client-maps protocols/nfs/connected-client-settings protocols/nfs/export-policies или export_policy_info protocols/nfs/export-policies/rules Требуется указать owning_resource protocols/nfs/kerberos/interfaces protocols/nfs/kerberos/realms или kerberos_realm_info protocols/nfs/services или vserver_nfs_info или nfs_info protocols/nvme/interfaces или nvme_interface_info protocols/nvme/services или nvme_info protocols/nvme/subsystems или nvme_subsystem_info protocols/nvme/subsystem-controllers protocols/nvme/subsystem-maps protocols/s3/buckets protocols/s3/services protocols/san/fcp/services или san_fcp_services или fcp_service_info protocols/san/igroups или nitiator_groups_info или igroup_info protocols/san/iscsi/credentials или san_iscsi_credentials protocols/san/iscsi/services или san_iscsi_services или iscsi_service_info protocols/san/iscsi/sessions protocols/san/lun-maps или san_lun_maps или lun_map_info protocols/san/portsets protocols/san/vvol-bindings protocols/vscan или vscan_status_info или vscan_info protocols/vscan/on-access-policies Требуется указать owning_resource protocols/vscan/on-demand-policies Требуется указать owning_resource protocols/vscan/scanner-pools Требуется указать owning_resource protocols/vscan/server-status или vscan_connection_status_all_info security security/accounts или security_login_info или security_login_account_info security/anti-ransomware/suspects security/audit security/audit/destinations или cluster_log_forwarding_info security/audit/messages security/authentication/cluster/ad-proxy security/authentication/cluster/ldap security/authentication/cluster/nis security/authentication/cluster/saml-sp security/authentication/publickeys security/aws-kms security/azure-key-vaults security/certificates security/gcp-kms security/ipsec security/ipsec/ca-certificates security/ipsec/policies security/ipsec/security-associations security/key-manager-configs security/key-managers security/key-stores security/login/messages security/multi-admin-verify security/multi-admin-verify/approval-groups security/multi-admin-verify/requests security/multi-admin-verify/rules security/roles или security_login_rest_role_info security/ssh security/ssh/svms snapmirror/policies или snapmirror_policy_info snapmirror/relationships или snapmirror_info storage/aggregates или aggregate_info storage/bridges или storage_bridge_info storage/cluster storage/disks или disk_info storage/file/clone/split-loads storage/file/clone/split-status storage/file/clone/tokens storage/file/moves storage/flexcache/flexcaches или storage_flexcaches_info storage/flexcache/origins или storage_flexcaches_origin_info storage/luns или storage_luns_info или lun_info (если указан serial_number, вычисляются serial_hex и naa_id) storage/namespaces или storage_NVMe_namespaces или nvme_namespace_info storage/pools storage/ports или storage_ports_info storage/qos/policies или storage_qos_policies или qos_policy_info или qos_adaptive_policy_info storage/qos/workloads storage/qtrees или storage_qtrees_config или qtree_info storage/quota/reports или storage_quota_reports или quota_report_info storage/quota/rules или storage_quota_policy_rules storage/shelves или storage_shelves_config или shelf_info storage/snaplock/audit-logs storage/snaplock/compliance-clocks storage/snaplock/event-retention/operations storage/snaplock/event-retention/policies storage/snaplock/file-fingerprints storage/snaplock/litigations storage/snapshot-policies или storage_snapshot_policies или snapshot_policy_info storage/switches storage/tape-devices storage/volumes или volume_info storage/volumes/snapshots Требуется указать owning_resource storage/volume-efficiency-policies или sis_policy_info support/autosupport или autosupport_config_info support/autosupport/check или autosupport_check_info support/autosupport/messages или autosupport_messages_history support/auto-update support/auto-update/configurations support/auto-update/updates support/configuration-backup support/configuration-backup/backups support/coredump/coredumps support/ems или support_ems_config support/ems/destinations или event_notification_info или event_notification_destination_info support/ems/events или support_ems_events support/ems/filters или support_ems_filters support/ems/messages support/snmp support/snmp/traphosts support/snmp/users svm/migrations svm/peers или svm_peers_info или vserver_peer_info svm/peer-permissions или svm_peer-permissions_info svm/svms или vserver_info Для следующих параметров нет прямого эквивалента в REST API aggr_efficiency_info cifs_vserver_security_info clock_info cluster_identity_info net_vlan_info sis_info snapmirror_destination_info system_node_info volume_space_info Можно указать список значений, чтобы включить более крупное подмножество. REST API поддерживаются начиная с ONTAP 9.6. По умолчанию: `["demo"]`
hal_linking логический	Если значение равно false, ссылки в кодировке HAL отключаются в вызовах REST. Возможные значения: `false` `true` ← (по умолчанию)
hostname строка / обязательный	Имя хоста или IP-адрес экземпляра ONTAP.
http_port целое число	Переопределяет порт по умолчанию (80 или 443), задавая этот порт.
https логический	Включает и отключает HTTPS. Игнорируется при использовании REST, поскольку поддерживается только HTTPS. Игнорируется при использовании аутентификации с сертификатом SSL, поскольку для неё требуется SSL. Возможные значения: `false` ← (по умолчанию) `true`
ignore_api_errors список / элементы=строка добавлено в netapp.ontap 21.23.0	Список подстрок. Если сообщение об ошибке при получении подмножества содержит одну из подстрок, выполнение модуля не завершается с ошибкой, а ошибка указывается в подмножестве.
key_filepath строка добавлено в netapp.ontap 20.6.0	Путь к файлу ключа клиента SSL.
lambda_config словарь добавлено в netapp.ontap 23.5.0	Параметры конфигурации прокси-функции AWS Lambda. Этот параметр и его подопции поддерживаются только при использовании REST.
aws_profile строка	Имя профиля AWS, используемого для аутентификации.
aws_region строка / обязательный	Название региона AWS.
function_name строка / обязательный	Имя вызываемой функции AWS Lambda.
max_records целое число	Максимальное количество записей, возвращаемых за один вызов. По умолчанию: `1024`
owning_resource словарь добавлено в netapp.ontap 21.19.0	К некоторым ресурсам нельзя обращаться напрямую. Их необходимо выбирать по владельцу или родительскому объекту. Например, для снимка требуется том. Для следующих подмножеств требуется ресурс-владелец; если uuid не указан, необходимо также задать следующие подопции. <application/consistency-groups/metrics> cg_name — имя группы согласованности, svm_name — имя владеющего группой согласованности vserver. <application/consistency-groups/snapshots> cg_name — имя группы согласованности, svm_name — имя владеющего группой согласованности vserver. <storage/volumes/snapshots> volume_name — имя тома, svm_name — имя владеющего томом vserver. <protocols/nfs/export-policies/rules> policy_name — имя политики, svm_name — имя владеющего политикой vserver, rule_index — индекс правила. <protocols/vscan/on-access-policies> svm_name — имя владеющего vscan vserver. <protocols/vscan/on-demand-policies> svm_name — имя владеющего vscan vserver. <protocols/vscan/scanner-pools> svm_name — имя владеющего vscan vserver.
parameters словарь добавлено в netapp.ontap 20.7.0	Позволяет передавать любые параметры REST.
password псевдонимы: pass строка	Пароль указанного пользователя.
state строка	Устарел начиная с версии 21.1.0. Этот параметр игнорировался и продолжает игнорироваться.
use_lambda логический добавлено в netapp.ontap 23.4.0	Указывает, следует ли использовать прокси-функцию AWS Lambda для подключения к системе ONTAP. Поддерживается только при использовании REST. Возможные значения: `false` ← (по умолчанию) `true`
use_python_keys логический добавлено в netapp.ontap 21.9.0	Если значение равно true, символ / в возвращаемых ключах словаря заменяется на _. Это позволяет использовать точечную нотацию при обработке выходных данных. Например, к ontap_info[“svm/svms”] можно обратиться как к ontap_info.svm_svms. Возможные значения: `false` ← (по умолчанию) `true`
use_rest строка	Этот модуль поддерживает только REST. always — всегда использовать REST API. Если модуль не поддерживает REST, выводится предупреждение. По умолчанию: `"always"`
username псевдонимы: user строка	Это может быть учётная запись с областью действия кластера или SVM — в зависимости от того, требуется ли API уровня кластера или SVM. Дополнительные сведения см. в документации: https://docs.netapp.com/us-en/ontap/authentication/create-svm-user-accounts-task.html. Поддерживаются два метода аутентификации: Базовая аутентификация с использованием имени пользователя и пароля. Аутентификация с сертификатом SSL с использованием файла сертификата клиента SSL и, при необходимости, файла закрытого ключа. Для использования сертификата он должен быть установлен в кластере ONTAP, а аутентификация по сертификату должна быть включена.
validate_certs логический	Если задано значение `no`, сертификаты SSL не проверяются. Задавать это значение следует только для `False` на контролируемых вами сайтах, использующих самозаверяющие сертификаты. Возможные значения: `false` `true` ← (по умолчанию)

Примечания

Примечание

security_login_role_config_info не имеет эквивалента в REST.
security_login_role_info не имеет эквивалента в REST.
security_key_manager_key_info не имеет эквивалента в REST.
vserver_motd_info не имеет эквивалента в REST.
vserver_login_banner_info не имеет эквивалента в REST.
vscan_connection_extended_stats_info не имеет эквивалента в REST.
env_sensors_info не имеет эквивалента в REST.
fcp_adapter_info не имеет эквивалента в REST.
net_dev_discovery_info не имеет эквивалента в REST.
net_failover_group_info не имеет эквивалента в REST.
net_firewall_info не имеет эквивалента в REST.
ntfs_dacl_info не имеет эквивалента в REST.
ntfs_sd_info не имеет эквивалента в REST.
role_info не имеет эквивалента в REST.
subsys_health_info не имеет эквивалента в REST.
volume_move_target_aggr_info не имеет эквивалента в REST.
Поддерживается функциональность прокси AWS Lambda. Пример использования см. в файле README.
Модули с префиксом na_ontap предназначены для поддержки платформы хранения ONTAP.
HTTPS включён по умолчанию и рекомендуется к использованию. Чтобы включить HTTP в кластере, выполните следующие команды: ‘set -privilege advanced;’ ‘system services web modify -http-enabled true;’

Примеры

- name: Run ONTAP gather facts for vserver info
  netapp.ontap.na_ontap_rest_info:
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    validate_certs: false
    gather_subset:
      - svm/svms

- name: Run ONTAP gather facts for aggregate info and volume info
  netapp.ontap.na_ontap_rest_info:
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    validate_certs: false
    gather_subset:
      - storage/aggregates
      - storage/volumes

- name: Run ONTAP gather facts for aggregate info and volume info with fields section
  netapp.ontap.na_ontap_rest_info:
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    fields:
      - '*'
    validate_certs: false
    gather_subset:
      - storage/aggregates
      - storage/volumes

- name: Run ONTAP gather facts for aggregate info with specified fields
  netapp.ontap.na_ontap_rest_info:
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    fields:
      - 'uuid'
      - 'name'
      - 'node'
    validate_certs: false
    gather_subset:
      - storage/aggregates
    parameters:
      recommend:
        true

- name: Get Snapshot info (owning_resource example)
  netapp.ontap.na_ontap_rest_info:
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    fields:
      - '*'
    validate_certs: false
    gather_subset:
      - storage/volumes/snapshots
    owning_resource:
      volume_name: volume_name
      svm_name: svm_name

- name: Run ONTAP gather facts for volume info with query on name and state
  netapp.ontap.na_ontap_rest_info:
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    validate_certs: false
    gather_subset:
      - storage/volumes
    parameters:
      name: ansible*
      state: online

- name: Run ONTAP gather fact to get DACLs
  netapp.ontap.na_ontap_rest_info:
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    validate_certs: false
    gather_subset:
      - file_directory_security
    parameters:
      vserver: svm1
      path: /vol1/qtree1
    use_python_keys: true

- name: Get ip network interface info
  netapp.ontap.na_ontap_rest_info:
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    validate_certs: false
    gather_subset:
      - ip_interfaces_info
    parameters:
      location.failover: home_node_only
      location.node.name: ontap_cluster
      service_policy.name: default-data-files

- name: Get aggregate info
  netapp.ontap.na_ontap_rest_info:
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    validate_certs: false
    gather_subset:
      - aggregate_info
    parameters:
      node.name: ontap_cluster
      block_storage.primary.raid_type: raid_dp

# assuming module_defaults is used to set hostname, username, ...
- name: Run demo subset using custom vsadmin role
  netapp.ontap.na_ontap_rest_info:
    gather_subset:
      - demo
    force_ontap_version: 9.8
    ignore_api_errors:
      - 'not authorized for that command'

# reports: {"cluster/nodes": {"error": {"code": "6", "message": "not authorized for that command"}}

Авторы

Команда NetApp Ansible (@carchi8py)

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

© 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/netapp/ontap/na_ontap_rest_info_module.html