intersight_memory_persistent_policy

Memory Persistent Policy configuration for Cisco Intersight

Collection: cisco.intersight

Full Name: cisco.intersight.intersight_memory_persistent_policy

Synopsis

Memory Persistent 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. Policies created within a Custom Organization are applicable only to devices in the same Organization.
name	string	yes		The name assigned to the Memory Persistent Policy. The name must be between 1 and 64 alphanumeric characters, allowing special characters :-_.
description	string			The user-defined description for the Memory Persistent 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.
management_mode	string		`configured-from-intersight`	Configuration management mode for Persistent Memory. C(configured-from-intersight) - Policy settings are configured and managed from Intersight. C(configured-from-operating-system) - Associated servers are managed by Operating System tools and policy settings are unavailable. When set to C(configured-from-operating-system), no other configuration fields are required or used. Choices: `configured-from-intersight`, `configured-from-operating-system`
enable_security_passphrase	bool		`false`	Enable secure passphrase for Persistent Memory Modules. When enabled, requires secure_passphrase parameter. Only applicable when management_mode is C(configured-from-intersight).
secure_passphrase	string			Secure passphrase to be applied on the Persistent Memory Modules on the server. Required when enable_security_passphrase is true. The allowed characters are a-z, A-Z, 0-9, and special characters =, !, &, Only applicable when management_mode is C(configured-from-intersight). Secret value; omitted from logs and results.
enable_goal	bool		`true`	Enable goal configuration for Persistent Memory Modules. The Goal configured will be applicable to all the Persistent Memory Modules. Goal modification will delete all existing regions and namespaces along with their data during profile deployment. New regions and namespaces will be created after goal modification. Only applicable when management_mode is C(configured-from-intersight).
memory_mode_percentage	int		`0`	Volatile memory percentage for Memory Mode. Valid range is 0-100. Only applicable when enable_goal is true and management_mode is C(configured-from-intersight).
persistent_memory_type	string		`app-direct`	Type of Persistent Memory configuration. C(app-direct) - Persistent Memory Modules are combined in an interleaved set. C(app-direct-non-interleaved) - Persistent Memory Modules are not interleaved. Only applicable when enable_goal is true and management_mode is C(configured-from-intersight). Choices: `app-direct`, `app-direct-non-interleaved`
retain_namespaces	bool		`true`	Retain existing Persistent Memory Namespaces. If false, all existing namespaces not listed in the namespaces parameter will be deleted along with their data. Only applicable when management_mode is C(configured-from-intersight).
namespaces	list			List of Logical Namespaces to be created or modified on the server. Only applicable when management_mode is C(configured-from-intersight). Nested options: name (str) required; socket_id (int) default=1; socket_memory_id (int) default=2; capacity (int) required; mode (str) default=raw

Example

yaml

- cisco.intersight.intersight_memory_persistent_policy:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    description: Persistent Memory policy with security and namespaces
    enable_goal: true
    enable_security_passphrase: true
    management_mode: configured-from-intersight
    memory_mode_percentage: 0
    name: pmem-policy-01
    namespaces:
        - capacity: 100000
          mode: raw
          name: ns1
          socket_id: 1
        - capacity: 1000065
          mode: block
          name: ns2
          socket_id: 4
    organization: default
    persistent_memory_type: app-direct
    retain_namespaces: true
    secure_passphrase: SecurePass123!
    state: present
  name: Create Memory Persistent Policy with Intersight management

- cisco.intersight.intersight_memory_persistent_policy:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    description: Non-interleaved persistent memory configuration
    enable_goal: true
    enable_security_passphrase: true
    management_mode: configured-from-intersight
    memory_mode_percentage: 0
    name: pmem-policy-non-interleaved
    namespaces:
        - capacity: 100000
          mode: raw
          name: ns1
          socket_id: 1
          socket_memory_id: 2
        - capacity: 200000
          mode: block
          name: ns2
          socket_id: 2
          socket_memory_id: 4
    organization: default
    persistent_memory_type: app-direct-non-interleaved
    retain_namespaces: true
    secure_passphrase: MySecurePass123
    state: present
  name: Create Memory Persistent Policy with non-interleaved configuration

- cisco.intersight.intersight_memory_persistent_policy:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    description: OS-managed persistent memory configuration
    management_mode: configured-from-operating-system
    name: pmem-policy-os-managed
    organization: default
    state: present
  name: Create Memory Persistent Policy with OS management

- cisco.intersight.intersight_memory_persistent_policy:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    description: Policy without security passphrase
    enable_goal: true
    enable_security_passphrase: false
    management_mode: configured-from-intersight
    memory_mode_percentage: 10
    name: pmem-policy-no-security
    persistent_memory_type: app-direct
    state: present
  name: Create Memory Persistent Policy without security passphrase

- cisco.intersight.intersight_memory_persistent_policy:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    name: pmem-policy-01
    state: absent
  name: Delete Memory Persistent Policy