Spec-Zone.ru › Ansible

Модуль netapp.ontap.na_ontap_rest_info – Сбор информации о NetApp ONTAP с помощью REST API

Примечание

Этот модуль является частью коллекции netapp.ontap (версия 22.12.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 или более поздняя.
  • Python3 — рекомендуется 3.9 или более поздняя версия.
  • При использовании ZAPI, netapp-lib 2018.11.13 или более поздняя версия (установка с помощью ‘pip install netapp-lib’), strongly рекомендуется netapp-lib 2020.3.12, так как она обеспечивает лучшую обработку ошибок при подключении.
  • физическая или виртуальная кластеризованная система 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, где каждый элемент является целым числом.

Когда use_rest установлено в auto, это может заставить произойти переключение на ZAPI в зависимости от версии и возможностей платформы.

Игнорируется с ZAPI.

gather_subset

список / элементы=строка

При указании этого аргумента, сбор информации будет ограничен заданным подмножеством.

Можно указать имя REST API или ZAPI. Возможные значения для этого аргумента:

application/applications или application_info

application/consistency-groups

application/templates или application_template_info

cloud/targets или cloud_targets_info

cluster

cluster/chassis или cluster_chassis_info

cluster/counter/tables

cluster/fireware/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

integer

Переопределить порт по умолчанию (80 или 443) на этот порт

https

boolean

Включить и выключить https.

Игнорируется при использовании REST, так как поддерживается только https.

Игнорируется при использовании аутентификации по SSL-сертификату, так как она требует SSL.

Варианты:

  • false ← (по умолчанию)
  • true

ignore_api_errors

list / elements=string

добавлено в netapp.ontap 21.23.0

Список подстрок.

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

key_filepath

string

добавлено в netapp.ontap 20.6.0

Путь к файлу ключа SSL-клиента.

max_records

integer

Максимальное количество записей, возвращаемых в одном вызове.

По умолчанию: 1024

ontapi

integer

Используемая версия API ontap.

owning_resource

dictionary

добавлено в netapp.ontap 21.19.0

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

Следующие подмножества требуют ресурса-владельца, а следующие подварианты, когда uuid не указан.

<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 — имя управляющего сервера (vserver) для vscan

<protocols/vscan/on-demand-policies> svm_name — имя управляющего сервера (vserver) для vscan

<protocols/vscan/scanner-pools> svm_name — имя управляющего сервера (vserver) для vscan

parameters

dictionary

добавлено в netapp.ontap 20.7.0

Позволяет передавать любые параметры REST.

password

aliases: pass

string

Пароль для указанного пользователя.

state

string

Устарело начиная с 21.1.0.

Этот параметр игнорировался и продолжает игнорироваться.

use_python_keys

boolean

добавлено в netapp.ontap 21.9.0

Если true, символ / в ключах возвращаемого словаря преобразуется в _.

Это позволяет использовать нотацию . при обработке вывода.

Например, ontap_info[“svm/svms”] можно получить как ontap_info.svm_svms.

Варианты:

  • false ← (по умолчанию)
  • true

use_rest

string

Использовать REST или ZAPI.

always — всегда использовать REST API, если модуль его поддерживает. Выдается предупреждение, если REST не поддерживается. Возникает ошибка, если параметр модуля не поддерживается в REST.

never — всегда использовать ZAPI, если модуль его поддерживает. Может возникнуть ошибка, если параметр REST не поддерживается в ZAPI.

auto — попытаться использовать REST API, если модуль его поддерживает и параметры модуля поддерживаются. В противном случае переходит к ZAPI.

По умолчанию: "auto"

username

aliases: user

string

Это может быть учетная запись уровня кластера или SVM, в зависимости от того, нужен ли API уровня кластера или SVM.

Дополнительную информацию можно найти в документации https://mysupport.netapp.com/NOW/download/software/nmsdk/9.4/.

Поддерживаются два метода аутентификации

  1. аутентификация по протоколу basic, используя имя пользователя и пароль,
  2. аутентификация по SSL-сертификату, используя файл SSL-сертификата клиента и, необязательно, файл закрытого ключа.

Для использования сертификата он должен быть установлен в кластере ONTAP, и должна быть включена аутентификация по сертификату.

validate_certs

boolean

Если установлено в значение 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.
  • Модули с префиксом 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: "1.2.3.4"
      username: "testuser"
      password: "test-password"
      https: true
      validate_certs: false
      use_rest: Always
      gather_subset:
        - svm/svms

- name: run ONTAP gather facts for aggregate info and volume info
  netapp.ontap.na_ontap_rest_info:
      hostname: "1.2.3.4"
      username: "testuser"
      password: "test-password"
      https: true
      validate_certs: false
      use_rest: Always
      gather_subset:
        - storage/aggregates
        - storage/volumes

- name: run ONTAP gather facts for all subsets
  netapp.ontap.na_ontap_rest_info:
      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
  netapp.ontap.na_ontap_rest_info:
      hostname: "1.2.3.4"
      username: "testuser"
      password: "test-password"
      https: true
      fields:
        - '*'
      validate_certs: false
      use_rest: Always
      gather_subset:
        - storage/aggregates
        - storage/volumes

- name: run ONTAP gather facts for aggregate info with specified fields
  netapp.ontap.na_ontap_rest_info:
      hostname: "1.2.3.4"
      username: "testuser"
      password: "test-password"
      https: true
      fields:
        - 'uuid'
        - 'name'
        - 'node'
      validate_certs: false
      use_rest: Always
      gather_subset:
        - storage/aggregates
      parameters:
        recommend:
          true

- name: Get Snapshot info (owning_resource example)
  netapp.ontap.na_ontap_rest_info:
      hostname: "1.2.3.4"
      username: "testuser"
      password: "test-password"
      https: true
      fields:
        - '*'
      validate_certs: false
      use_rest: Always
      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: "1.2.3.4"
      username: "testuser"
      password: "test-password"
      https: true
      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: "1.2.3.4"
    username: "testuser"
    password: "test-password"
    https: true
    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: "1.2.3.4"
    username: "testuser"
    password: "test-password"
    https: true
    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: "1.2.3.4"
    username: "testuser"
    password: "test-password"
    https: true
    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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/netapp/ontap/na_ontap_rest_info_module.html

Spec-Zone.ru

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