intersight_certificate_management_policy

Certificate Management Policy configuration for Cisco Intersight

Collection: cisco.intersight

Full Name: cisco.intersight.intersight_certificate_management_policy

Synopsis

Certificate Management Policy configuration for Cisco Intersight

Parameters

Name	Type	Required	Default	Description
api_private_key	string			Filename (absolute path) or string of PEM formatted private key data to be used for Intersight API authentication. If a string is used, Ansible vault should be used to encrypt string data. Ex. ansible-vault encrypt_string –vault-id tme@/Users/dsoper/Documents/vault_password_file ‘—–BEGIN EC PRIVATE KEY—– —–END EC PRIVATE KEY—–’ If not set, the value of the INTERSIGHT_API_PRIVATE_KEY environment variable is used. Required if I(api_bearer_token) is not provided. Secret value; omitted from logs and results.
api_uri	string		`https://intersight.com/api/v1`	URI used to access the Intersight API. If not set, the value of the INTERSIGHT_API_URI environment variable is used.
api_key_id	string			Public API Key ID associated with the private key. If not set, the value of the INTERSIGHT_API_KEY_ID environment variable is used. Required if I(api_bearer_token) is not provided.
api_bearer_token	string			Bearer token for OAuth2 authentication with the Intersight API. When provided, I(api_key_id) and I(api_private_key) are not required and the C(cryptography) Python library is not needed. If not set, the value of the INTERSIGHT_API_BEARER_TOKEN environment variable is used. Secret value; omitted from logs and results.
validate_certs	bool		`true`	Boolean control for verifying the api_uri TLS certificate
use_proxy	bool		`true`	If C(no), it will not use a proxy, even if one is defined in an environment variable on the target hosts.
state	string		`present`	If C(present), will verify the resource is present and will create if needed. If C(absent), will verify the resource is absent and will delete if needed. Choices: `present`, `absent`
organization	string		`default`	The name of the Organization this resource is assigned to. Profiles and Policies that are created within a Custom Organization are applicable only to devices in the same Organization.
name	string	yes		The name assigned to the Certificate Management Policy. The name must be between 1 and 64 alphanumeric characters, allowing special characters :-_.
description	string			The user-defined description for the Certificate Management Policy. Description can contain letters(a-z, A-Z), numbers(0-9), hyphen(-), period(.), colon(:), or an underscore(_).
tags	list			List of tags in Key: Value: format.
certificates	list			List of certificates to manage in the policy. Can include Root CA certificates and IMC certificates. Only one IMC certificate can be configured per policy. Nested options: certificate_type (str) required; certificate_name (str); certificate (str) required; private_key (str) secret; enabled (bool) default=true

Example

yaml

- cisco.intersight.intersight_certificate_management_policy:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    certificates:
        - certificate: LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0t...
          certificate_name: RootCA-01
          certificate_type: rootca
          enabled: true
    description: Certificate management policy with Root CA
    name: CertMgmt-Policy-01
    organization: default
    state: present
  name: Create Certificate Management Policy with Root CA certificate

- cisco.intersight.intersight_certificate_management_policy:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    certificates:
        - certificate: LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0t...
          certificate_type: imc
          enabled: true
          private_key: LS0tLS1CRUdJTiBSU0EgUFJJVkFURSBLRVktLS0tLQ...
    description: Certificate management policy with IMC certificate
    name: CertMgmt-Policy-02
    state: present
  name: Create Certificate Management Policy with IMC certificate

- cisco.intersight.intersight_certificate_management_policy:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    certificates:
        - certificate: LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0t...
          certificate_name: RootCA-01
          certificate_type: rootca
          enabled: true
        - certificate: LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0t...
          certificate_type: imc
          enabled: true
          private_key: LS0tLS1CRUdJTiBSU0EgUFJJVkFURSBLRVktLS0tLQ...
    description: Certificate management policy with both certificate types
    name: CertMgmt-Policy-03
    state: present
  name: Create Certificate Management Policy with both types

- cisco.intersight.intersight_certificate_management_policy:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    certificates: []
    name: CertMgmt-Policy-01
    state: present
  name: Update policy - remove all certificates

- cisco.intersight.intersight_certificate_management_policy:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    name: CertMgmt-Policy-01
    state: absent
  name: Delete Certificate Management Policy