intersight_drive_security_policy

Drive Security Policy configuration for Cisco Intersight

Collection: cisco.intersight

Full Name: cisco.intersight.intersight_drive_security_policy

Synopsis

Drive Security 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, Policies, and Pools that are created within a Custom Organization are applicable only to devices in the same Organization.
name	string	yes		The name assigned to the Drive Security Policy. The name must be between 1 and 64 alphanumeric characters, allowing special characters :-_.
description	string			The user-defined description for the Drive Security 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.
manual_key	dict			Configuration for manual key management. Use this for local key management with manual passphrase. Either C(manual_key) or C(remote_key) must be specified, but not both. Secret value; omitted from logs and results. Nested options: new_key (str) required secret; existing_key (str) secret
remote_key	dict			Configuration for remote key management using KMIP server. Use this for remote key management with KMIP protocol. Either C(manual_key) or C(remote_key) must be specified, but not both. Secret value; omitted from logs and results. Nested options: primary_server (dict) {Nested options: enable_drive_security (bool) required; ip_address (str); port (int) default=5696; timeout (int) default=60}; secondary_server (dict) {Nested options: enable_drive_security (bool) required; ip_address (str); port (int) default=5696; timeout (int) default=60}; server_certificate (str) required; use_authentication (bool) default=false; username (str); password (str) secret; existing_key (str) secret

Example

yaml

- cisco.intersight.intersight_drive_security_policy:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    description: Drive security policy with manual key management
    manual_key:
        new_key: MyS3cur3P@ssw0rd
    name: manual-drive-security-policy
    organization: default
    state: present
    tags:
        - Key: Environment
          Value: Production
  name: Create Drive Security Policy with Manual Key

- cisco.intersight.intersight_drive_security_policy:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    description: Drive security policy with manual key management
    manual_key:
        existing_key: MyS3cur3P@ssw0rd
        new_key: MyN3wS3cur3P@ssw0rd
    name: manual-drive-security-policy
    organization: default
    state: present
  name: Create Drive Security Policy with Manual Key (updating existing)

- cisco.intersight.intersight_drive_security_policy:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    description: Drive security policy with KMIP
    name: kmip-drive-security-policy
    organization: default
    remote_key:
        primary_server:
            enable_drive_security: true
            ip_address: 192.168.1.100
            port: 5696
            timeout: 60
        secondary_server:
            enable_drive_security: false
        server_certificate: LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0t...
        use_authentication: false
    state: present
  name: Create Drive Security Policy with KMIP (Primary Server Only)

- cisco.intersight.intersight_drive_security_policy:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    description: Drive security policy with KMIP and authentication
    name: kmip-auth-drive-security-policy
    organization: default
    remote_key:
        password: kmip_password
        primary_server:
            enable_drive_security: true
            ip_address: 192.168.1.100
            port: 5696
            timeout: 60
        secondary_server:
            enable_drive_security: true
            ip_address: 192.168.1.101
            port: 5696
            timeout: 60
        server_certificate: LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0t...
        use_authentication: true
        username: kmip_user
    state: present
  name: Create Drive Security Policy with KMIP (Both Servers with Authentication)

- cisco.intersight.intersight_drive_security_policy:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    name: manual-drive-security-policy
    organization: default
    state: absent
  name: Delete Drive Security Policy