netapp.storagegrid.na_sg_grid_client_certificate 模块 – 管理 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_client_certificate。

netapp.storagegrid 21.11.0 中的新功能

概要

  • 在 NetApp StorageGRID 上创建、更新、删除客户端证书。

参数

参数

注释

allow_prometheus

布尔值

外部监控工具是否可以访问 Prometheus 指标。

选项

  • false

  • true

api_url

字符串 / 必需

StorageGRID 管理节点 REST API 的 URL。

auth_token

字符串 / 必需

API 请求的授权令牌

certificate_id

字符串

客户端证书的 ID。

display_name

字符串

客户端证书配置的显示名称。

如果也指定了 certificate_id，则可以修改此参数。

public_key

字符串

PEM 编码的 X.509 客户端证书。

state

字符串

指定的证书是否应存在。

选项

  • "present" ← (默认)

  • "absent"

validate_certs

布尔值

是否应验证 https 证书？

选项

  • false

  • true ← (默认)

注意

注意

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

示例

- name: create client certificate
  netapp.storagegrid.na_sg_grid_client_certificate:
    api_url: "https://<storagegrid-endpoint-url>"
    auth_token: "storagegrid-auth-token"
    validate_certs: false
    state: present
    display_name: client-cert1
    public_key: |
      -----BEGIN CERTIFICATE-----
      MIIC6DCCAdACCQC7l4WukhKD0zANBgkqhkiG9w0BAQsFADA2..swCQYDVQQGEwJB
      BAMMHnNnYW4wMS5kZXYubWljcm9icmV3Lm5ldGFwcC5hdTCC..IwDQYJKoZIhvcN
      AQEBBQADggEPADCCAQoCggEBAMvjm9I35lmKcC7ITVL8+QiZ..lvdkbfZCUQrfdy
      71inP+XmPjs0rnkhICA9ItODteRcVlO+t7nDTfm7HgG0mJFk..m0ffyEYrcx24qu
      S7gXYQjRsJmrep1awoaCa20BMGuqK2WKI3IvZ7YiT22qkBqK..+hIFffX6u3Jy+B
      77pR6YcATtpMHW/AaOx+OX9l80dIRsRZKMDxYQ==
      -----END CERTIFICATE-----
    allow_prometheus: true

- name: rename client certificate
  netapp.storagegrid.na_sg_grid_client_certificate:
    api_url: "https://<storagegrid-endpoint-url>"
    auth_token: "storagegrid-auth-token"
    validate_certs: false
    state: present
    certificate_id: 00000000-0000-0000-0000-000000000000
    display_name: client-cert1-rename
    public_key: |
      -----BEGIN CERTIFICATE-----
      MIIC6DCCAdACCQC7l4WukhKD0zANBgkqhkiG9w0BAQsFADA2..swCQYDVQQGEwJB
      BAMMHnNnYW4wMS5kZXYubWljcm9icmV3Lm5ldGFwcC5hdTCC..IwDQYJKoZIhvcN
      AQEBBQADggEPADCCAQoCggEBAMvjm9I35lmKcC7ITVL8+QiZ..lvdkbfZCUQrfdy
      71inP+XmPjs0rnkhICA9ItODteRcVlO+t7nDTfm7HgG0mJFk..m0ffyEYrcx24qu
      S7gXYQjRsJmrep1awoaCa20BMGuqK2WKI3IvZ7YiT22qkBqK..+hIFffX6u3Jy+B
      77pR6YcATtpMHW/AaOx+OX9l80dIRsRZKMDxYQ==
      -----END CERTIFICATE-----
    allow_prometheus: true

- name: delete client certificate
  netapp.storagegrid.na_sg_grid_client_certificate:
    api_url: "https://<storagegrid-endpoint-url>"
    auth_token: "storagegrid-auth-token"
    validate_certs: false
    state: absent
    display_name: client-cert1-rename

返回值

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

键

描述

resp

字典

返回有关 StorageGRID 服务器证书的信息。

返回： 成功

示例： {"allowPrometheus": true, "displayName": "client-cert1", "expiryDate": "2024-01-01T00:00:00.000Z", "id": "abcABC_01234-0123456789abcABCabc0123456789==", "publicKey": "-----BEGIN CERTIFICATE-----MIIC6DCCAdACCQC7l4WukhKD0zANBgkqhkiG9w0BAQsFADA2MQswCQYDVQQGE...-----END CERTIFICATE-----"}

作者

  • NetApp Ansible 团队 (@joshedmonds)