cisco.intersight.intersight_device_connector_policy module – Device Connector Policy configuration for Cisco Intersight

Note

This module is part of the cisco.intersight collection (version 2.8.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install cisco.intersight.

To use it in a playbook, specify: cisco.intersight.intersight_device_connector_policy.

Synopsis

  • Manages Device Connector Policy configuration on Cisco Intersight.

  • A policy to configure device connector settings for Cisco Intersight managed devices.

  • Enables or disables configuration lockout on the endpoint to prevent local configuration changes.

  • For more information see Cisco Intersight.

Parameters

Parameter

Comments

api_key_id

string / required

Public API Key ID associated with the private key.

If not set, the value of the INTERSIGHT_API_KEY_ID environment variable is used.

api_private_key

path / required

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-----

<your private key data>

-----END EC PRIVATE KEY-----’

If not set, the value of the INTERSIGHT_API_PRIVATE_KEY environment variable is used.

api_uri

string

URI used to access the Intersight API.

If not set, the value of the INTERSIGHT_API_URI environment variable is used.

Default: "https://intersight.com/api/v1"

description

aliases: descr

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(_).

enable_lockout

boolean

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.

Choices:

  • false ← (default)

  • true

name

string / required

The name assigned to the Device Connector Policy.

The name must be between 1 and 62 alphanumeric characters, allowing special characters :-_.

organization

string

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.

Default: "default"

state

string

If present, will verify the resource is present and will create if needed.

If absent, will verify the resource is absent and will delete if needed.

Choices:

  • "present" ← (default)

  • "absent"

tags

list / elements=dictionary

List of tags in Key:<user-defined key> Value:<user-defined value> format.

Default: []

use_proxy

boolean

If no, it will not use a proxy, even if one is defined in an environment variable on the target hosts.

Choices:

  • false

  • true ← (default)

validate_certs

boolean

Boolean control for verifying the api_uri TLS certificate

Choices:

  • false

  • true ← (default)

Examples

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

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

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

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

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

api_response

dictionary

The API response output returned by the specified resource.

Returned: always

Sample: {"api_response": {"Description": "Device connector policy with lockout enabled", "LockoutEnabled": true, "Name": "device-connector-lockout-policy", "ObjectType": "deviceconnector.Policy", "Organization": {"Moid": "675450ee69726530014753e2", "ObjectType": "organization.Organization"}, "Tags": [{"Key": "Environment", "Value": "Production"}]}}

Authors

  • Ron Gershburg (@rgershbu)