intersight_device_connector_policy

Device Connector Policy configuration for Cisco Intersight

Collection: cisco.intersight

Full Name: cisco.intersight.intersight_device_connector_policy

Synopsis

Device Connector 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 Device Connector Policy. The name must be between 1 and 64 alphanumeric characters, allowing special characters :-_.
description	string			The user-defined description for the Device Connector 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.
enable_lockout	bool		`false`	Enables configuration lockout on the endpoint. When enabled, prevents local configuration changes on the device through IMC or CIMC interfaces. Lockout ensures that all configuration changes must be made through Intersight.

Example

yaml

- cisco.intersight.intersight_device_connector_policy:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    description: Device connector policy with lockout enabled
    enable_lockout: true
    name: device-connector-lockout-policy
    organization: default
    state: present
    tags:
        - Key: Environment
          Value: Production
  name: Create Device Connector Policy with lockout enabled

- cisco.intersight.intersight_device_connector_policy:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    description: Device connector policy with lockout disabled
    enable_lockout: false
    name: device-connector-no-lockout-policy
    organization: default
    state: present
  name: Create Device Connector Policy with lockout disabled

- cisco.intersight.intersight_device_connector_policy:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    description: Updated device connector policy
    enable_lockout: false
    name: device-connector-lockout-policy
    organization: default
    state: present
  name: Update existing Device Connector Policy

- cisco.intersight.intersight_device_connector_policy:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    name: device-connector-lockout-policy
    organization: default
    state: absent
  name: Delete Device Connector Policy