intersight_local_user_policy

Local User Policy configuration for Cisco Intersight

Collection: cisco.intersight

Full Name: cisco.intersight.intersight_local_user_policy

Synopsis

Local User 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 Local User Policy. The name must be between 1 and 64 alphanumeric characters, allowing special characters :-_.
description	string			The user-defined description of the Local User 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.
enforce_strong_password	bool		`true`	If true, enables a strong password policy. Strong password requirements:. A. The password must have a minimum of 8 and a maximum of 20 characters. B. The password must not contain the User’s Name. C. The password must contain characters from three of the following four categories. 1) English uppercase characters (A through Z). 2) English lowercase characters (a through z). 3) Base 10 digits (0 through 9). 4) Non-alphabetic characters (! , @, ‘#’, $, %, ^, &, *, -, _, +, =).
enable_password_expiry	bool		`false`	Enables password expiry on the endpoint.
password_history	int		`5`	Specifies number of times a password cannot repeat when changed (value between 0 and 5). Entering 0 disables this option.
local_users	list			List of local users on the endpoint. An admin user already exists on the endpoint. Add the admin user here only if you want to change the password, or enable or disable the user. To add admin user, provide a username as ‘admin’, select the admin user role, and then proceed. Nested options: username (str) required; enable (bool) default=true; role (str) required; password (str) required secret; endpoint_role_type (str) default=IMC; account_types (list)
purge	bool		`false`	The purge argument instructs the module to consider the resource definition absolute. If true, any previously configured usernames will be removed from the policy with the exception of the `admin` user which cannot be deleted.
always_update_password	bool		`false`	Since passwords are not returned by the API and are encrypted on the endpoint, this option will instruct the module when to change the password. If true, the password for each user will always be updated in the policy. If false, the password will be updated only if the user is created.

Example

yaml

- intersight_local_user_policy:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    description: User named guest with admin role
    local_users:
        - password: vault_guest_password
          role: admin
          username: guest
        - password: vault_reader_password
          role: readonly
          username: reader
    name: guest-admin
    tags:
        - Key: username
          Value: guest
  name: Configure Local User policy

- intersight_local_user_policy:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    description: User with IPMI account type
    local_users:
        - account_types:
            - IPMI
          password: vault_ipmi_password
          role: admin
          username: ipmi-user
    name: ipmi-admin
  name: Configure Local User policy with IPMI user

- intersight_local_user_policy:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    description: User with local and IPMI account types
    local_users:
        - account_types:
            - Local
            - IPMI
          password: vault_local_ipmi_password
          role: admin
          username: local-ipmi
    name: local-ipmi-admin
  name: Configure Local User policy with local and IPMI access

- intersight_local_user_policy:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    name: guest-admin
    state: absent
  name: Delete Local User policy