intersight_kvm_policy

Virtual KVM Policy configuration for Cisco Intersight

Collection: cisco.intersight

Full Name: cisco.intersight.intersight_kvm_policy

Synopsis

Virtual KVM 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 KVM Policy. The name must be between 1 and 64 alphanumeric characters, allowing special characters :-_.
description	string			The user-defined description for the KVM 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.
enabled	bool		`true`	State of the vKVM service on the endpoint. When set to false, all other configuration parameters are ignored and only the enabled state is configured. When set to true, all other configuration parameters take effect.
maximum_sessions	int		`4`	The maximum number of concurrent KVM sessions allowed. Valid range is 1-4 sessions. This parameter is ignored when C(enabled) is C(false).
remote_port	int		`2068`	The port used for KVM communication. Valid range is 1024-65535. This parameter is ignored when C(enabled) is C(false).
enable_video_encryption	bool		`true`	If enabled, encrypts all video information sent through KVM. Please note that this can no longer be disabled for servers running versions 4.2 and above. This parameter is ignored when C(enabled) is C(false).
enable_local_server_video	bool		`true`	If enabled, displays KVM session on any monitor attached to the server. This parameter is ignored when C(enabled) is C(false).
tunneled_kvm_enabled	bool		`false`	Enables Tunneled vKVM on the endpoint. Applicable only for Device Connectors that support Tunneled vKVM. This parameter is ignored when C(enabled) is C(false).

Example

yaml

- cisco.intersight.intersight_kvm_policy:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    description: KVM policy with standard settings
    enabled: true
    name: Default-KVM-Policy
    tags:
        - Key: Environment
          Value: Production
  name: Create an enabled KVM Policy with default settings

- cisco.intersight.intersight_kvm_policy:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    description: KVM policy with custom port and session limits
    enable_local_server_video: false
    enable_video_encryption: true
    enabled: true
    maximum_sessions: 2
    name: Custom-KVM-Policy
    remote_port: 3000
    tags:
        - Key: Owner
          Value: DevOps
    tunneled_kvm_enabled: true
  name: Create a KVM Policy with custom settings

- cisco.intersight.intersight_kvm_policy:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    description: Disabled KVM policy for security compliance
    enabled: false
    name: Disabled-KVM-Policy
    tags:
        - Key: Security
          Value: Disabled
  name: Create a disabled KVM Policy

- cisco.intersight.intersight_kvm_policy:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    name: Old-KVM-Policy
    state: absent
  name: Delete a KVM Policy