netapp.storagegrid.na_sg_grid_gateway 模块 – 管理 StorageGRID 上的负载均衡器(网关)端点。

注意

此模块是 netapp.storagegrid 集合(版本 21.13.0)的一部分。

如果您正在使用 ansible 包,您可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装,请运行 ansible-galaxy collection list

要安装它,请使用:ansible-galaxy collection install netapp.storagegrid

要在 playbook 中使用它,请指定:netapp.storagegrid.na_sg_grid_gateway

netapp.storagegrid 21.7.0 中的新增功能

概要

  • 在 StorageGRID 上创建或更新负载均衡器端点。

  • 如果未指定 *private_key*,则此模块是幂等的。

  • 该模块将基于 *port* 和 *display_name* 匹配现有配置。

  • 如果存在多个使用相同端口和显示名称的负载均衡器端点,请使用 *gateway_id* 选择所需的端点。

参数

参数

注释

api_url

字符串 / 必需

StorageGRID 管理节点 REST API 的 URL。

auth_token

字符串 / 必需

API 请求的授权令牌

binding_mode

字符串

在 netapp.storagegrid 21.9.0 中添加

用于限制负载均衡器端点可访问性的绑定模式。

除 *global* 之外的绑定模式需要 StorageGRID 11.5 或更高版本。

选择

  • "global" ← (默认)

  • "ha-groups"

  • "node-interfaces"

ca_bundle

字符串

串联 PEM 编码的中间 CA 证书包。

当没有中间 CA 时省略。

default_service_type

字符串

通过负载均衡器代理的服务类型。

选择

  • "s3" ← (默认)

  • "swift"

display_name

字符串

配置的显示名称。

如果还指定了 *gateway_id*,则可以修改此参数。

enable_ipv4

布尔值

指示是否侦听 IPv4 上的连接。

选择

  • false

  • true ← (默认)

enable_ipv6

布尔值

指示是否侦听 IPv6 上的连接。

选择

  • false

  • true ← (默认)

gateway_id

字符串

在 netapp.storagegrid 21.9.0 中添加

负载均衡器端点的 ID。

ha_groups

列表 / elements=字符串

在 netapp.storagegrid 21.9.0 中添加

一组 StorageGRID HA 组的名称或 UUID,用于将负载均衡器端点绑定到。

除非 *binding_mode=ha-groups*,否则将忽略该选项。

node_interfaces

列表 / elements=字典

在 netapp.storagegrid 21.9.0 中添加

一组 StorageGRID 节点接口,用于将负载均衡器端点绑定到。

interface

字符串

要绑定的接口。eth0 对应于网格网络,eth1 对应于管理网络,eth2 对应于客户端网络。

node

字符串

StorageGRID 节点的名称。

port

整数 / 必需

提供流量服务的 TCP 端口。

创建负载均衡器端点后,无法修改此参数。

private_key

字符串

PEM 编码的证书私钥。

如果 *server_certificate* 不为空,则为必需。

secure

布尔值

负载均衡器端点是服务 HTTP 还是 HTTPS 流量。

创建负载均衡器端点后,无法修改此参数。

选择

  • false

  • true ← (默认)

server_certificate

字符串

PEM 编码的 X.509 服务器证书。

如果使用默认证书,则省略。

state

字符串

是否应配置指定的负载均衡器端点。

选择

  • "present" ← (默认)

  • "absent"

validate_certs

布尔值

是否应验证 https 证书?

选择

  • false

  • true ← (默认)

注释

注意

  • 前缀为 na_sg 的模块旨在管理 NetApp StorageGRID。

示例

- name: Create and Upload Certificate to a Gateway Endpoint with global binding
  netapp.storagegrid.na_sg_grid_gateway:
    api_url: "https://<storagegrid-endpoint-url>"
    auth_token: "storagegrid-auth-token"
    displayName: "FabricPool Endpoint"
    port: 10443
    secure: True
    enable_ipv4: True
    enable_ipv6: True
    default_service_type: "s3"
    server_certificate: |
      -----BEGIN CERTIFICATE-----
      MIIC6DCCAdACCQC7l4WukhKD0zANBgkqhkiG9w0BAQsFADA2..swCQYDVQQGEwJB
      BAMMHnNnYW4wMS5kZXYubWljcm9icmV3Lm5ldGFwcC5hdTCC..IwDQYJKoZIhvcN
      AQEBBQADggEPADCCAQoCggEBAMvjm9I35lmKcC7ITVL8+QiZ..lvdkbfZCUQrfdy
      71inP+XmPjs0rnkhICA9ItODteRcVlO+t7nDTfm7HgG0mJFk..m0ffyEYrcx24qu
      S7gXYQjRsJmrep1awoaCa20BMGuqK2WKI3IvZ7YiT22qkBqK..+hIFffX6u3Jy+B
      77pR6YcATtpMHW/AaOx+OX9l80dIRsRZKMDxYQ==
      -----END CERTIFICATE-----
    private_key: |
      -----BEGIN PRIVATE KEY-----
      MIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIB..DL45vSN+ZZinAu
      L25W0+cz1Oi69AKkI7d9nbFics2ay5+7o+4rKqf3en2R4MSx..vy+iDlOmATib5O
      x8TN5pJ9AgMBAAECggEADDLM8tHXXUoUFihzv+BUwff8p8Yc..cXFcSes+xTd5li
      po8lNsx/v2pQx4ByBkuaYLZGIEXOWS6gkp44xhIXgQKBgQD4..7862u5HLbmhrV3
      vs8nC69b3QKBgQDacCD8d8JpwPbg8t2VjXM3UvdmgAaLUfU7..DWV+W3jqzmDOoN
      zWVgPbPNj0UmzvLDbgxLoxe77wjn2BHsAJVAfJ9VeQKBgGqF..gYO+wHR8lJUoa5
      ZEe8Upy2oBtvND/0dnwO2ym2FGsBJN0Gr4NKdG5vkzLsthKk..Rm0ikwEUOUZQKE
      K8J5yEVeo9K2v3wggtq8fYn6
      -----END PRIVATE KEY-----
    validate_certs: false

- name: Create a HTTP Gateway Endpoint with HA Group Binding
  netapp.storagegrid.na_sg_grid_gateway:
    api_url: "https://<storagegrid-endpoint-url>"
    auth_token: "storagegrid-auth-token"
    displayName: "App Endpoint 1"
    port: 10501
    secure: false
    enable_ipv4: True
    enable_ipv6: True
    default_service_type: "s3"
    binding_mode: ha-groups
    ha_groups: site1_ha_group
    validate_certs: false

- name: Create a HTTP Gateway Endpoint with Node Interface Binding
  netapp.storagegrid.na_sg_grid_gateway:
    api_url: "https://<storagegrid-endpoint-url>"
    auth_token: "storagegrid-auth-token"
    displayName: "App Endpoint 2"
    port: 10502
    secure: false
    enable_ipv4: True
    enable_ipv6: True
    default_service_type: "s3"
    binding_mode: node-interfaces
    node_interfaecs:
    - node: SITE1_ADM1
      interface: eth2
    - node: SITE2_ADM1
      interface: eth2
    validate_certs: false

- name: Delete Gateway Endpoint
  netapp.storagegrid.na_sg_grid_gateway:
    api_url: "https://<storagegrid-endpoint-url>"
    auth_token: "storagegrid-auth-token"
    displayName: "App Endpoint 2"
    port: 10502
    default_service_type: "s3"
    validate_certs: false

返回值

常见的返回值记录在此处,以下是此模块特有的字段

描述

resp

字典

返回有关 StorageGRID 负载均衡器端点的信息。

返回:成功

示例: {"accountId": "0", "certSource": "plaintext", "defaultServiceType": "s3", "displayName": "ansibletest-secure", "enableIPv4": true, "enableIPv6": true, "id": "ffffffff-ffff-ffff-ffff-ffffffffffff", "plaintextCertData": {"caBundleEncoded": "-----BEGIN CERTIFICATE-----MIIDdTCCAl2gAwIBAgILBAAAAAABFUtaw5QwDQYJKoZIhvcNAQEFBQAwVzELM...-----END CERTIFICATE-----", "metadata": {"...": null}, "serverCertificateEncoded": "-----BEGIN CERTIFICATE-----MIIC6DCCAdACCQC7l4WukhKD0zANBgkqhkiG9w0BAQsFADA2MQswCQYDVQQGE...-----END CERTIFICATE-----"}, "port": 10443, "secure": true}

作者

  • NetApp Ansible 团队 (@jkandati)