cisco.intersight.intersight_ssh_policy module – SSH Policy configuration for Cisco Intersight

Note

This module is part of the cisco.intersight collection (version 2.12.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_ssh_policy.

Synopsis

  • Manages SSH Policy configuration on Cisco Intersight.

  • A policy to configure SSH service settings on Cisco Intersight managed servers.

  • This policy is applicable only for UCS Servers (Standalone).

  • 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 SSH Policy.

Description can contain letters(a-z, A-Z), numbers(0-9), hyphen(-), period(.), colon(:), or an underscore(_).

enable_ssh

boolean

State of SSH service on the endpoint.

If set to false, SSH service will be disabled and ssh_port and ssh_timeout will be ignored.

Choices:

  • false

  • true ← (default)

name

string / required

The name assigned to the SSH 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"

ssh_port

integer

Port used for secure shell access.

Valid range is 1-65535.

This parameter is only used when enable_ssh is true.

Default: 22

ssh_timeout

integer

Number of seconds to wait before the system considers a SSH request to have timed out.

Valid range is 60-10800 seconds.

This parameter is only used when enable_ssh is true.

Default: 1800

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.

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 SSH Policy with default settings
  cisco.intersight.intersight_ssh_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    organization: "default"
    name: "SSH-Policy-Default"
    description: "SSH policy with default settings"
    tags:
      - Key: "Environment"
        Value: "Production"
    enable_ssh: true
    state: present

- name: Create SSH Policy with custom port and timeout
  cisco.intersight.intersight_ssh_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    name: "SSH-Policy-Custom"
    description: "SSH policy with custom port and timeout"
    enable_ssh: true
    ssh_port: 2222
    ssh_timeout: 3600
    state: present

- name: Create SSH Policy with SSH disabled
  cisco.intersight.intersight_ssh_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    name: "SSH-Policy-Disabled"
    description: "SSH policy with SSH service disabled"
    enable_ssh: false
    state: present

- name: Delete SSH Policy
  cisco.intersight.intersight_ssh_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    name: "SSH-Policy-Default"
    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": {"Enabled": true, "Name": "SSH-Policy-Default", "ObjectType": "ssh.Policy", "Port": 22, "Tags": [{"Key": "Environment", "Value": "Production"}], "Timeout": 1800}}

Authors

  • Ron Gershburg (@rgershbu)