Parameter | -Type | -Required | -Default | -Choices | -Description | -
---|---|---|---|---|---|
certificate_id | -str | -- | - | - | Unique identifier of the certificate. Mandatory only for modify operation. |
-
certificate_type | -str | -- | - |
|
- Type of the certificate. |
-
service | -str | -- | - |
|
- Type of the service for which the certificate is used. Mandatory for reset and exchange operation. |
-
scope | -str | -- | - | - | Defines a subset of certificates belonging to one Service. |
-
certificate | -str | -- | - | - | Concatenated PEM encoded x509_certificate string from end-entity certificate to root certificate. |
-
remote_address | -str | -- | - | - | IPv4 or DNS name of the remote cluster. |
-
remote_user | -str | -- | - | - | The username of the remote cluster. |
-
remote_password | -str | -- | - | - | The password of the remote cluster. |
-
remote_port | -int | -- | - | - | The port address of the remote cluster. |
-
is_current | -bool | -- | - | - | Indicates whether this is the current X509 certificate to be used by the service or this X509 Certificate will be used in the future. |
-
state | -str | -True | -- |
|
- Define whether the certificate should exist or not. |
-
array_ip | -str | -True | -- | - | IP or FQDN of the PowerStore management system. |
-
verifycert | -bool | -True | -- |
|
- Boolean variable to specify whether to validate SSL certificate or not. True - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS_CA_BUNDLE to the path of the SSL certificate. False - indicates that the SSL certificate should not be verified. |
-
user | -str | -True | -- | - | The username of the PowerStore host. |
-
password | -str | -True | -- | - | The password of the PowerStore host. |
-
timeout | -int | -- | 120 | -- | Time after which the connection will get terminated. It is to be mentioned in seconds. |
-
port | -int | -- | - | - | Port number for the PowerStore array. If not passed, it will take 443 as default. |
-
Key | -Type | -Returned | -Description | -||
---|---|---|---|---|---|
certificate_details | -complex | -When certificate exists | -Details of the certificate. | -||
- | id | -str | -success | -The system generated ID given to the certificate. | -|
- | is_current | -bool | -success | -Whether the certificate can be used now or not. | -|
- | is_valid | -bool | -success | -Indicates whether this is a valid X509 certificate. | -|
- | members | -complex | -success | -Member certificates included in this x509_certificate. | -|
- | - | certificate | -str | -success | -Base64 encoded certificate without any line breaks. | -
- | - | depth | -str | -success | -Depth indicates the position of this member certificate in the X509 Certificate chain. | -
- | - | issuer | -str | -success | -Distinguished name of the certificate issuer. | -
- | - | key_length | -int | -success | -Private key length. | -
- | - | public_key_algorithm | -str | -success | -Public key algorithm used to generate the key pair. | -
- | - | serial_number | -str | -success | -Certificate serial number. | -
- | - | signature_algorithm | -str | -success | -Certificate signature algorithm. | -
- | - | subject | -str | -success | -Certificate subject or so called distinguished name. | -
- | - | subject_alternative_names | -list | -success | -Additional DNS names or IP addresses in the x509_certificate. | -
- | - | thumbprint | -str | -success | -CeHash value of the certificate. | -
- | - | thumbprint_algorithm | -str | -success | -The thumbprint algorithm. | -
- | - | thumbprint_algorithm_l10n | -str | -success | -Localized message string corresponding to thumbprint_algorithm. | -
- | - | valid_from | -str | -success | -Date and time when the certificate becomes valid. | -
- | - | valid_to | -str | -success | -Date and time when the certificate will expire. | -
- | service | -str | -success | -Type of the service for which the certificate is used. | -|
- | service_l10n | -str | -success | -Localized message string corresponding to service. | -|
- | type | -str | -success | -Type of the certificate. | -|
- | type_l10n | -str | -success | -Localized message string corresponding to type. | -|
changed | -bool | -always | -Whether or not the resource has changed. | -
Parameter | -Type | -Required | -Default | -Choices | -Description | -||
---|---|---|---|---|---|---|---|
cluster_name | -str | -- | - | - | The Name of cluster. |
- ||
chap_mode | -str | -- | - |
|
- The mode that describes or sets the iSCSI CHAP mode for the cluster. |
- ||
cluster_id | -str | -- | - | - | Id of the cluster. |
- ||
new_name | -str | -- | - | - | The new name for the cluster. |
- ||
service_password | -str | -- | - | - | The password for the service user. |
- ||
appliance_id | -str | -- | - | - | ID of the appliance. Parameters appliance_id and appliance_name are mutually exclusive. Parameter is_ssh_enabled has to be passed along with appliance_id. |
- ||
appliance_name | -str | -- | - | - | Name of the appliance. Parameters appliance_id and appliance_name are mutually exclusive. Parameter is_ssh_enabled has to be passed along with appliance_name. |
- ||
is_ssh_enabled | -bool | -- | - | - | Whether SSH access is enabled for the cluster. Either appliance_id or appliance_name is to be passed along with is_ssh_enabled. |
- ||
physical_mtu | -int | -- | - | - | MTU for ethernet ports in the cluster. The MTU can be set between 1500 to 9000. |
- ||
ignore_network_warnings | -bool | -- | - | - | Whether to ignore the network warning about unreachable external network. |
- ||
appliances | - list elements: dict |
- - | - | - | Appliance configuration setting during cluster creation. This is mandatory for create cluster operation. |
- ||
- | link_local_address | -str | -True | -- | - | The unique IPv4 address of the appliance and is set by zeroconf. |
- |
- | name | -str | -- | - | - | Name of new appliance. |
- |
- | drive_failure_tolerance_level | -str | -- | - |
|
- Specifies the possible drive failure tolerance levels. |
- |
dns_servers | - list elements: str |
- - | - | - | DNS server addresses in IPv4 format. At least one DNS server should be provided. This is mandatory for create cluster operation. |
- ||
ntp_servers | - list elements: str |
- - | - | - | NTP server addresses in IPv4 or hostname format. At least one NTP server should be provided. This is mandatory for create cluster operation. |
- ||
physical_switches | - list elements: dict |
- - | - | - | Physical switch setting for a new cluster. |
- ||
- | name | -str | -True | -- | - | Name of the physical switch. |
- |
- | purpose | -str | -True | -- |
|
- Specifies the purpose of the physical switch. |
- |
- | connections | - list elements: dict |
- True | -- | - | specifies the supported connection for the physical switch. |
- |
- | - | address | -str | -True | -- | - | Specifies the physical switch address in IPv4 or DNS hostname format. |
-
- | - | port | -int | -- | - | - | Specifies the port used for connection to switch. |
-
- | - | connect_method | -str | -True | -- |
|
- Specifies the connection method type for the physical Switch. |
-
- | - | username | -str | -- | - | - | Specifies username to connect a physical switch for SSH connection method. |
-
- | - | ssh_password | -str | -- | - | - | Specifies SSH password to connect a physical switch. |
-
- | - | snmp_community_string | -str | -- | - | - | Specifies SNMPv2 community string, if SNMPv2 connect method is selected. |
-
networks | - list elements: dict |
- - | - | - | Configuration of one or more network(s) based on network type. This is mandatory for create cluster operation. |
- ||
- | type | -str | -True | -- |
|
- Specifies the type of the network. |
- |
- | vlan_id | -int | -- | - | - | The ID of the VLAN. |
- |
- | prefix_length | -int | -True | -- | - | Network prefix length. |
- |
- | gateway | -str | -- | - | - | Network gateway in IPv4 format. |
- |
- | cluster_mgmt_address | -str | -- | - | - | New cluster management IP address in IPv4 format. |
- |
- | storage_discovery_address | -str | -- | - | - | New storage discovery IP address in IPv4 format. This can be specified only when configure the storage network type. |
- |
- | addresses | - list elements: str |
- True | -- | - | IP addresses in IPv4 format. |
- |
- | purposes | - list elements: str |
- - | - |
|
- Purpose of the network. Only applicable for storage network. |
- |
vcenters | - list elements: dict |
- - | - | - | Configure vCenter settings when creating cluster. Currently, for vcenters parameter API supports only single element. This is required when creating PowerStore X cluster and optional for PowerStore T. |
- ||
- | address | -str | -True | -- | - | IP address of vCenter in IPv4 or hostname format. |
- |
- | username | -str | -True | -- | - | User name to login to vCenter. |
- |
- | password | -str | -True | -- | - | Password to login to vCenter. |
- |
- | is_verify_server_cert | -bool | -True | -- | - | Whether or not the connection will be secured with the vcenter SSL certificate. |
- |
- | data_center_name | -str | -- | - | - | Name of the data center. This is used to join an existing datacenter in vcenter. This should be specified when creating PowerStore X cluster. Mutually exclusive with data_center_id. |
- |
- | data_center_id | -str | -- | - | - | The VMWare ID of datacenter. This is used to join an existing datacenter in vcenter. This should be specified when creating PowerStore X cluster. Mutually exclusive with data_center_name. |
- |
- | esx_cluster_name | -str | -- | - | - | Name of the ESXi cluster. This should be specified when creating PowerStore X cluster. |
- |
- | vasa_provider_credentials | -dict | -True | -- | - | Storage system credentials for vCenter to use for communicating with the storage system using VASA. |
- |
- | - | username | -str | -True | -- | - | Username of the local user account which will be used by vSphere to register VASA provider. |
-
- | - | password | -str | -True | -- | - | Password of the local user account which will be used by vSphere to register VASA provider. |
-
is_http_redirect_enabled | -bool | -- | - | - | Whether to redirect the HTTP requests to HTTPS. |
- ||
validate_create | -bool | -- | True | -- | Whether to perform create cluster validate call. |
- ||
wait_for_completion | -bool | -- | False | -- | Flag to indicate if the operation should be run synchronously or asynchronously. True signifies synchronous execution. By default, create cluster operation will run asynchronously. |
- ||
state | -str | -True | -- |
|
- Define whether the cluster should exist or not. Value present indicates that the cluster should exist on the system. Value absent indicates that the cluster should not exist on the system. |
- ||
array_ip | -str | -True | -- | - | IP or FQDN of the PowerStore management system. |
- ||
verifycert | -bool | -True | -- |
|
- Boolean variable to specify whether to validate SSL certificate or not. True - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS_CA_BUNDLE to the path of the SSL certificate. False - indicates that the SSL certificate should not be verified. |
- ||
user | -str | -True | -- | - | The username of the PowerStore host. |
- ||
password | -str | -True | -- | - | The password of the PowerStore host. |
- ||
timeout | -int | -- | 120 | -- | Time after which the connection will get terminated. It is to be mentioned in seconds. |
- ||
port | -int | -- | - | - | Port number for the PowerStore array. If not passed, it will take 443 as default. |
-
Key | -Type | -Returned | -Description | -||||
---|---|---|---|---|---|---|---|
changed | -bool | -always | -Whether or not the resource has changed. | -||||
cluster_details | -complex | -When Cluster exists. | -The cluster details. | -||||
- | appliance_count | -int | -success | -Number of appliances configured in this cluster. | -|||
- | appliance_details | -complex | -success | -Name and Id of the appliance for which is_ssh_enabled parameter is used. | -|||
- | - | id | -str | -success | -Id of the appliance. | -||
- | - | name | -str | -success | -Name of the appliance. | -||
- | compatibility_level | -int | -success | -The behavioral version of the software version API, It is used to ensure the compatibility across potentially different software versions. | -|||
- | global_id | -str | -success | -The global unique identifier of the cluster. | -|||
- | id | -str | -success | -The ID of the cluster. | -|||
- | is_encryption_enabled | -bool | -success | -Whether or not Data at Rest Encryption is enabled on the cluster. | -|||
- | is_ssh_enabled | -bool | -success | -Whether or not the ssh is enabled. | -|||
- | management_address | -str | -success | -The floating management IP address for the cluster in IPv4 or IPv6 format. | -|||
- | master_appliance_id | -str | -success | -The unique identifier of the appliance acting as primary. This parameter is deprecated in version 2.0.0.0. | -|||
- | name | -str | -success | -Name of the cluster. | -|||
- | physical_mtu | -int | -success | -MTU for the cluster. | -|||
- | primary_appliance_id | -str | -success | -The unique identifier of the appliance acting as primary. This parameter was added in version 2.0.0.0. | -|||
- | service_config_details | -complex | -success | -Details of the service config for the entered appliance. | -|||
- | - | appliance_id | -str | -success | -Id of the appliance for which the service configuration exists. | -||
- | - | id | -str | -success | -Id of the service configuration. | -||
- | - | is_ssh_enabled | -bool | -success | -Whether the ssh is enabled for the appliance or not. | -||
- | service_user_details | -complex | -success | -Details of the service user for which the password can be updated. | -|||
- | - | id | -str | -success | -Id of the service user. | -||
- | - | is_built_in | -bool | -success | -Whether the service user is built in or not. | -||
- | - | is_default_password | -bool | -success | -Whether the service user has default password or not. | -||
- | - | name | -str | -success | -Name of the service user. | -||
- | state | -str | -success | -Possible cluster states. | -|||
- | storage_discovery_address | -str | -success | -The floating storage discovery IP address for the cluster in IPv4 or IPv6 format. | -|||
- | system_time | -str | -success | -Current clock time for the system. System time and all the system reported times are in UTC (GMT+0:00) format. | -|||
job_details | -complex | -When asynchronous task is performed. | -The job details. | -||||
- | id | -str | -success | -The ID of the job. | -
Parameter | -Type | -Required | -Default | -Choices | -Description | -
---|---|---|---|---|---|
dns_id | -str | -True | -- | - | Unique identifier of the DNS instance. |
-
dns_addresses | - list elements: str |
- - | - | - | DNS server addresses in IPv4 format. |
-
dns_address_state | -str | -- | - |
|
- State of the addresses mentioned in dns_addresses. |
-
state | -str | -True | -- |
|
- The state of the DNS instance after the task is performed. For get and modify operations it should be set to "present". |
-
array_ip | -str | -True | -- | - | IP or FQDN of the PowerStore management system. |
-
verifycert | -bool | -True | -- |
|
- Boolean variable to specify whether to validate SSL certificate or not. True - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS_CA_BUNDLE to the path of the SSL certificate. False - indicates that the SSL certificate should not be verified. |
-
user | -str | -True | -- | - | The username of the PowerStore host. |
-
password | -str | -True | -- | - | The password of the PowerStore host. |
-
timeout | -int | -- | 120 | -- | Time after which the connection will get terminated. It is to be mentioned in seconds. |
-
port | -int | -- | - | - | Port number for the PowerStore array. If not passed, it will take 443 as default. |
-
Key | -Type | -Returned | -Description | -|
---|---|---|---|---|
changed | -bool | -always | -Whether or not the resource has changed. | -|
dns_details | -complex | -When DNS exists. | -Details of the DNS instance. | -|
- | addresses | -str | -success | -DNS server addresses in IPv4 format. | -
- | id | -str | -success | -Unique identifier of DNS instance. | -
Parameter | -Type | -Required | -Default | -Choices | -Description | -|
---|---|---|---|---|---|---|
email_id | -str | -- | - | - | Unique identifier of the destination email address. Mutually exclusive with email_address. |
- |
email_address | -str | -- | - | - | Email address to receive notifications. Mutually exclusive with email_id. |
- |
new_address | -str | -- | - | - | New email address to receive notifications. |
- |
send_test_email | -bool | -- | False | -- | Whether to send the test email to the destination email address. |
- |
notify | -dict | -- | - | - | Whether to send different types of notifications. It contains below optional candidate variables. |
- |
- | critical | -bool | -False | -- | - | Whether to send notifications for critical alerts. |
-
- | major | -bool | -False | -- | - | Whether to send notifications for major alerts. |
-
- | minor | -bool | -False | -- | - | Whether to send notifications for minor alerts. |
-
- | info | -bool | -False | -- | - | Whether to send notifications for informational alerts. |
-
state | -str | -True | -- |
|
- The state of the destination email address after the task is performed. For Delete operation only, it should be set to "absent". For all Create, Modify, Test or Get details operations it should be set to "present". |
- |
array_ip | -str | -True | -- | - | IP or FQDN of the PowerStore management system. |
- |
verifycert | -bool | -True | -- |
|
- Boolean variable to specify whether to validate SSL certificate or not. True - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS_CA_BUNDLE to the path of the SSL certificate. False - indicates that the SSL certificate should not be verified. |
- |
user | -str | -True | -- | - | The username of the PowerStore host. |
- |
password | -str | -True | -- | - | The password of the PowerStore host. |
- |
timeout | -int | -- | 120 | -- | Time after which the connection will get terminated. It is to be mentioned in seconds. |
- |
port | -int | -- | - | - | Port number for the PowerStore array. If not passed, it will take 443 as default. |
-
Key | -Type | -Returned | -Description | -||
---|---|---|---|---|---|
changed | -bool | -always | -Whether or not the resource has changed. | -||
email_details | -complex | -When destination email address exists | -Details of the destination email address. | -||
- | email_address | -str | -success | -Email address to receive notifications. | -|
- | id | -str | -success | -The system generated ID of the destination email instance. | -|
- | notify | -complex | -success | -['Whether to send different types of notifications.'] | -|
- | - | critical | -bool | -success | -Whether to send notifications for critical alerts. | -
- | - | info | -bool | -success | -Whether to send notifications for informational alerts. | -
- | - | major | -bool | -success | -Whether to send notifications for major alerts. | -
- | - | minor | -bool | -success | -Whether to send notifications for minor alerts. | -
Parameter | -Type | -Required | -Default | -Choices | -Description | -|
---|---|---|---|---|---|---|
filesystem_name | -str | -- | - | - | Name of the file system. Mutually exclusive with filesystem_id. Mandatory only for create operation. |
- |
filesystem_id | -str | -- | - | - | Unique id of the file system. Mutually exclusive with filesystem_name. |
- |
description | -str | -- | - | - | Description of the file system. |
- |
nas_server | -str | -- | - | - | Name or ID of the NAS Server on which the file system is created. Mandatory parameter whenever filesystem_name is provided, since filesystem names are unique only within a NAS server. |
- |
size | -int | -- | - | - | Size that the file system presents to the host or end user. Mandatory only for create operation. |
- |
cap_unit | -str | -- | - |
|
- Capacity unit for the size. It defaults to 'GB', if not specified. |
- |
access_policy | -str | -- | - |
|
- File system security access policies. |
- |
locking_policy | -str | -- | - |
|
- File system locking policies. ADVISORY- No lock checking for NFS and honor SMB lock range only for SMB. MANDATORY- Honor SMB and NFS lock range. |
- |
folder_rename_policy | -str | -- | - |
|
- File system folder rename policies for the file system with multi-protocol access enabled. ALL_ALLOWED - All protocols are allowed to rename directories without any restrictions. SMB_FORBIDDEN - A directory rename from the SMB protocol will be denied if at least one file is opened in the directory or in one of its child directories. All_FORBIDDEN - Any directory rename request will be denied regardless of the protocol used, if at least one file is opened in the directory or in one of its child directories. |
- |
smb_properties | -dict | -- | - | - | Advance settings for SMB. It contains below optional candidate variables. |
- |
- | is_smb_sync_writes_enabled | -bool | -False | -- | - | Indicates whether the synchronous writes option is enabled on the file system. |
-
- | is_smb_no_notify_enabled | -bool | -False | -- | - | Indicates whether notifications of changes to directory file structure are enabled. |
-
- | is_smb_op_locks_enabled | -bool | -False | -- | - | Indicates whether opportunistic file locking is enabled on the file system. |
-
- | is_smb_notify_on_access_enabled | -bool | -False | -- | - | Indicates whether file access notifications are enabled on the file system. |
-
- | is_smb_notify_on_write_enabled | -bool | -False | -- | - | Indicates whether file write notifications are enabled on the file system. |
-
- | smb_notify_on_change_dir_depth | -int | -False | -- | - | Integer variable , determines the lowest directory level to which the enabled notifications apply. minimum value is 1. |
-
protection_policy | -str | -- | - | - | Name or ID of the protection policy applied to the file system. Specifying "" (empty string) removes the existing protection policy from file system. |
- |
quota_defaults | -dict | -- | - | - | Contains the default attributes for a filesystem quota.It contains below optional candidate variables. |
- |
- | grace_period | -int | -False | -- | - | Grace period of soft limit. |
-
- | grace_period_unit | -str | -False | -- |
|
- Unit of the grace period of soft limit. |
-
- | default_hard_limit | -int | -False | -- | - | Default hard limit of user quotas and tree quotas. |
-
- | default_soft_limit | -int | -False | -- | - | Default soft limit of user quotas and tree quotas. |
-
- | cap_unit | -str | -False | -- |
|
- Capacity unit for default hard & soft limit. |
-
state | -str | -True | -- |
|
- Define whether the filesystem should exist or not. |
- |
array_ip | -str | -True | -- | - | IP or FQDN of the PowerStore management system. |
- |
verifycert | -bool | -True | -- |
|
- Boolean variable to specify whether to validate SSL certificate or not. True - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS_CA_BUNDLE to the path of the SSL certificate. False - indicates that the SSL certificate should not be verified. |
- |
user | -str | -True | -- | - | The username of the PowerStore host. |
- |
password | -str | -True | -- | - | The password of the PowerStore host. |
- |
timeout | -int | -- | 120 | -- | Time after which the connection will get terminated. It is to be mentioned in seconds. |
- |
port | -int | -- | - | - | Port number for the PowerStore array. If not passed, it will take 443 as default. |
-
Key | -Type | -Returned | -Description | -|
---|---|---|---|---|
changed | -bool | -always | -Whether or not the resource has changed. | -|
filesystem_details | -complex | -When filesystem exists | -Details of the filesystem. | -|
- | access_policy | -str | -success | -Access policy about the filesystem. | -
- | default_hard_limit | -int | -success | -Default hard limit period for a filesystem quota in byte. | -
- | default_soft_limit | -int | -success | -Default soft limit period for a filesystem quota in byte. | -
- | description | -str | -success | -The description about the filesystem. | -
- | grace_period | -int | -success | -Default grace period for a filesystem quota in second. | -
- | id | -str | -success | -The system generated ID given to the filesystem. | -
- | is_smb_no_notify_enabled | -bool | -success | -Whether smb notify policy is enabled for a filesystem. | -
- | is_smb_notify_on_access_enabled | -bool | -success | -Whether smb on access notify policy is enabled. | -
- | is_smb_op_locks_enabled | -bool | -success | -Whether smb op lock is enabled. | -
- | locking_policy | -str | -success | -Locking policy about the filesystem. | -
- | name | -str | -success | -Name of the filesystem. | -
- | nas_server | -dict | -success | -Id and name of the nas server to which the filesystem belongs. | -
- | protection_policy | -dict | -success | -Id and name of the protection policy associated with the filesystem. | -
- | size_total | -int | -success | -Total size of the filesystem in bytes. | -
- | size_used | -int | -success | -Used size of the filesystem in bytes. | -
- | snapshots | -list | -success | -Id and name of the snapshots of a filesystem. | -
- | total_size_with_unit | -str | -success | -Total size of the filesystem with appropriate unit. | -
- | used_size_with_unit | -str | -success | -Used size of the filesystem with appropriate unit. | -
Parameter | -Type | -Required | -Default | -Choices | -Description | -
---|---|---|---|---|---|
snapshot_name | -str | -- | - | - | The name of the filesystem snapshot. Mandatory for create operation. Specify either snapshot name or ID (but not both) for any operation. |
-
snapshot_id | -str | -- | - | - | The ID of the Snapshot. |
-
filesystem | -str | -- | - | - | The ID/Name of the filesystem for which snapshot will be taken. If filesystem name is specified, then nas_server is required to uniquely identify the filesystem. Mandatory for create operation. |
-
nas_server | -str | -- | - | - | The NAS server, this could be the name or ID of the NAS server. |
-
description | -str | -- | - | - | The description for the filesystem snapshot. |
-
desired_retention | -int | -- | - | - | The retention value for the Snapshot. If the desired_retention/expiration_timestamp is not mentioned during creation, snapshot will be created with unlimited retention. Maximum supported desired retention is 31 days. |
-
retention_unit | -str | -- | hours | -
|
- The unit for retention. |
-
expiration_timestamp | -str | -- | - | - | The expiration timestamp of the snapshot. This should be provided in UTC format, e.g 2020-07-24T10:54:54Z. To remove the expiration timestamp, specify it as an empty string. |
-
access_type | -str | -- | - |
|
- Specifies whether the snapshot directory or protocol access is granted to the filesystem snapshot. For create operation, if access_type is not specified, snapshot will be created with 'SNAPSHOT' access type. |
-
state | -str | -True | -- |
|
- Define whether the filesystem snapshot should exist or not. |
-
array_ip | -str | -True | -- | - | IP or FQDN of the PowerStore management system. |
-
verifycert | -bool | -True | -- |
|
- Boolean variable to specify whether to validate SSL certificate or not. True - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS_CA_BUNDLE to the path of the SSL certificate. False - indicates that the SSL certificate should not be verified. |
-
user | -str | -True | -- | - | The username of the PowerStore host. |
-
password | -str | -True | -- | - | The password of the PowerStore host. |
-
timeout | -int | -- | 120 | -- | Time after which the connection will get terminated. It is to be mentioned in seconds. |
-
port | -int | -- | - | - | Port number for the PowerStore array. If not passed, it will take 443 as default. |
-
Key | -Type | -Returned | -Description | -||
---|---|---|---|---|---|
changed | -bool | -always | -Whether or not the resource has changed. | -||
create_fs_snap | -bool | -always | -Whether or not the resource has created. | -||
delete_fs_snap | -bool | -always | -Whether or not the resource has deleted. | -||
filesystem_snap_details | -dict | -When snapshot exists. | -Details of the snapshot. | -||
- | access_type | -str | -success | -Displays the type of access allowed to the snapshot. | -|
- | creation_timestamp | -str | -success | -The date and time the snapshot was created. | -|
- | description | -str | -success | -Description of the filesystem snapshot. | -|
- | expiration_timestamp | -str | -success | -The date and time the snapshot is due to be automatically deleted by the system. | -|
- | id | -str | -success | -Unique identifier of the filesystem snapshot instance. | -|
- | name | -str | -success | -The name of the snapshot. | -|
- | nas_server | -dict | -success | -Details of NAS server on which snapshot is present. | -|
- | - | id | -str | -success | -ID of the NAS server. | -
- | - | name | -str | -success | -Name of the NAS server | -
- | parent_id | -str | -success | -ID of the filesystem on which snapshot is taken. | -|
- | parent_name | -str | -success | -Name of the filesystem on which snapshot is taken. | -|
modify_fs_snap | -bool | -always | -Whether or not the resource has modified. | -
Parameter | -Type | -Required | -Default | -Choices | -Description | -|
---|---|---|---|---|---|---|
host_name | -str | -- | - | - | The host name. This value must contain 128 or fewer printable Unicode characters. Creation of an empty host is not allowed. Required when creating a host. Use either host_id or host_name for modify and delete tasks. |
- |
host_id | -str | -- | - | - | The 36 character long host id automatically generated when a host is created. Use either host_id or host_name for modify and delete tasks. The host_id cannot be used while creating host, as it is generated by the array after creation of host. |
- |
os_type | -str | -- | - |
|
- Operating system of the host. Required when creating a host. OS type cannot be modified for a given host. |
- |
initiators | - list elements: str |
- - | - | - | List of Initiator WWN or IQN or NQN to be added or removed from the host. Subordinate initiators in a host can only be of one type, either FC or iSCSI. Required when creating a host. It is mutually exclusive with detailed_initiators. |
- |
detailed_initiators | - list elements: dict |
- - | - | - | Initiator properties. It is mutually exclusive with initiators. |
- |
- | port_name | -str | -True | -- | - | Name of port type. The port_name is mandatory key. |
-
- | port_type | -str | -- | - |
|
- Protocol type of the host initiator. |
-
- | chap_single_username | -str | -- | - | - | Username for single CHAP authentication. CHAP username is required when the cluster CHAP mode is mutual authentication. Minimum length is 1 and maximum length is 64 characters. |
-
- | chap_single_password | -str | -- | - | - | Password for single CHAP authentication. CHAP password is required when the cluster CHAP mode is mutual authentication. Minimum length is 12 and maximum length is 64 characters. |
-
- | chap_mutual_username | -str | -- | - | - | Username for mutual CHAP authentication. CHAP username is required when the cluster CHAP mode is mutual authentication. Minimum length is 1 and maximum length is 64 characters. |
-
- | chap_mutual_password | -str | -- | - | - | Password for mutual CHAP authentication. CHAP password is required when the cluster CHAP mode is mutual authentication. Minimum length is 12 and maximum length is 64 characters. |
-
state | -str | -True | -- |
|
- Define whether the host should exist or not. Value present - indicates that the host should exist in system. Value absent - indicates that the host should not exist in system. |
- |
initiator_state | -str | -- | - |
|
- Define whether the initiators should be present or absent in host. Value present-in-host - indicates that the initiators should exist on host. Value absent-in-host - indicates that the initiators should not exist on host. Required when creating a host with initiators or adding/removing initiators to/from existing host. |
- |
new_name | -str | -- | - | - | The new name of host for renaming function. This value must contain 128 or fewer printable Unicode characters. Cannot be specified when creating a host. |
- |
host_connectivity | -str | -- | - |
|
- Connectivity type for host. If any of metro connectivity options specified, a metro host must exists in both cluster provide connectivity to a metro volume from both cluster. |
- |
array_ip | -str | -True | -- | - | IP or FQDN of the PowerStore management system. |
- |
verifycert | -bool | -True | -- |
|
- Boolean variable to specify whether to validate SSL certificate or not. True - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS_CA_BUNDLE to the path of the SSL certificate. False - indicates that the SSL certificate should not be verified. |
- |
user | -str | -True | -- | - | The username of the PowerStore host. |
- |
password | -str | -True | -- | - | The password of the PowerStore host. |
- |
timeout | -int | -- | 120 | -- | Time after which the connection will get terminated. It is to be mentioned in seconds. |
- |
port | -int | -- | - | - | Port number for the PowerStore array. If not passed, it will take 443 as default. |
-
Key | -Type | -Returned | -Description | -|||||
---|---|---|---|---|---|---|---|---|
changed | -bool | -always | -Whether or not the resource has changed. | -|||||
host_details | -complex | -When host exists | -Details of the host. | -|||||
- | description | -str | -success | -Description about the host. | -||||
- | host_connectivity | -str | -success | -Connectivity type for host. It was added in 3.0.0.0. | -||||
- | host_group_id | -str | -success | -The host group ID of host. | -||||
- | host_initiators | -complex | -success | -The initiator details of this host. | -||||
- | - | active_sessions | -list | -success | -List of active login sessions between an initiator and a target port. | -|||
- | - | chap_mutual_username | -str | -success | -Username for mutual CHAP authentication. | -|||
- | - | chap_single_username | -str | -success | -Username for single CHAP authentication. | -|||
- | - | port_name | -str | -success | -Name of the port. | -|||
- | - | port_type | -str | -success | -The type of the port. | -|||
- | id | -str | -success | -The system generated ID given to the host. | -||||
- | mapped_hosts | -complex | -success | -This is the inverse of the resource type host_volume_mapping association. | -||||
- | - | host_group | -dict | -success | -Details about a host group to which host is mapped. | -|||
- | - | - | id | -str | -success | -ID of the host group. | -||
- | - | - | name | -str | -success | -Name of the host group. | -||
- | - | id | -str | -success | -Unique identifier of a mapping between a host and a volume. | -|||
- | - | logical_unit_number | -int | -success | -Logical unit number for the host volume access. | -|||
- | - | volume | -dict | -success | -Details about a volume which has mapping with the host. | -|||
- | - | - | id | -str | -success | -ID of the volume. | -||
- | - | - | name | -str | -success | -Name of the volume. | -||
- | name | -str | -success | -Name of the host. | -||||
- | os_type | -str | -success | -The os type of the host. | -||||
- | type | -str | -success | -Type of the host. | -
Parameter | -Type | -Required | -Default | -Choices | -Description | -
---|---|---|---|---|---|
hostgroup_name | -str | -- | - | - | The host group name. This value must contain 128 or fewer printable Unicode characters. Creation of an empty host group is not allowed. Required when creating a host group. Use either hostgroup_id or hostgroup_name for modify and delete tasks. |
-
hostgroup_id | -str | -- | - | - | The 36-character long host group id, automatically generated when a host group is created. Use either hostgroup_id or hostgroup_name for modify and delete tasks. The hostgroup_id cannot be used while creating host group, as it is generated by the array after creation of host group. |
-
hosts | - list elements: str |
- - | - | - | List of hosts to be added or removed from the host group. Subordinate hosts in a host group can only be of one type, either FC or iSCSI. Required when creating a host group. To represent host, both name or ID can be used interchangeably. The module will detect both. |
-
state | -str | -True | -- |
|
- Define whether the host group should exist or not. Value present - indicates that the host group should exist on the system. Value absent - indicates that the host group should not exist on the system. Deletion of a host group results in deletion of the containing hosts as well. Remove hosts from the host group first to retain them. |
-
host_state | -str | -- | - |
|
- Define whether the hosts should be present or absent in host group. Value present-in-group - indicates that the hosts should exist on the host group. Value absent-in-group - indicates that the hosts should not exist on the host group. Required when creating a host group with hosts or adding/removing hosts from existing host group. |
-
new_name | -str | -- | - | - | The new name for host group renaming function. This value must contain 128 or fewer printable Unicode characters. |
-
host_connectivity | -str | -- | - |
|
- Connectivity type for host group. If any of metro connectivity options specified, a metro host group must exists in both cluster provide connectivity to a metro volume from both cluster. |
-
array_ip | -str | -True | -- | - | IP or FQDN of the PowerStore management system. |
-
verifycert | -bool | -True | -- |
|
- Boolean variable to specify whether to validate SSL certificate or not. True - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS_CA_BUNDLE to the path of the SSL certificate. False - indicates that the SSL certificate should not be verified. |
-
user | -str | -True | -- | - | The username of the PowerStore host. |
-
password | -str | -True | -- | - | The password of the PowerStore host. |
-
timeout | -int | -- | 120 | -- | Time after which the connection will get terminated. It is to be mentioned in seconds. |
-
port | -int | -- | - | - | Port number for the PowerStore array. If not passed, it will take 443 as default. |
-
Key | -Type | -Returned | -Description | -||
---|---|---|---|---|---|
changed | -bool | -always | -Whether or not the resource has changed. | -||
hostgroup_details | -complex | -When host group exists | -Details of the host group. | -||
- | description | -str | -success | -Description about the host group. | -|
- | host_connectivity | -str | -success | -Connectivity type for host group. It was added in 3.0.0.0. | -|
- | hosts | -complex | -success | -The hosts details which are part of this host group. | -|
- | - | id | -str | -success | -The ID of the host. | -
- | - | name | -str | -success | -The name of the host. | -
- | id | -str | -success | -The system generated ID given to the host group. | -|
- | name | -str | -success | -Name of the host group. | -
Parameter | -Type | -Required | -Default | -Choices | -Description | -|
---|---|---|---|---|---|---|
gather_subset | - list elements: str |
- True | -- |
|
- A list of string variables which specify the PowerStore system entities requiring information. Volumes - vol. All the nodes - node. Volume groups - vg. Protection policies - protection_policy. Hosts - host. Host groups - hg. Snapshot rules - snapshot_rule. NAS servers - nas_server. NFS exports - nfs_export. SMB shares - smb_share. Tree quotas - tree_quota. User quotas - user_quota. File systems - file_system. Replication rules - replication_rule. Replication sessions - replication_session. Remote systems - remote_system. Various networks - network. Roles - role. Local users - user. Appliances - appliance. Security configurations - security_config. Certificates - certificate. Active directories - ad. LDAPs - ldap. DNS servers - dns. NTP servers - ntp. Email notification destinations - email_notification. SMTP configurations - smtp_config. Remote Support - remote_support. Remote support contacts - remote_support_contact. LDAP accounts - ldap_account. LDAP domain - ldap_domain. |
- |
filters | - list elements: dict |
- - | - | - | A list of filters to support filtered output for storage entities. Each filter is a list of filter_key, filter_operator, filter_value. Supports passing of multiple filters. |
- |
- | filter_key | -str | -True | -- | - | Name identifier of the filter. |
-
- | filter_operator | -str | -True | -- |
|
- Operation to be performed on the filter key. |
-
- | filter_value | -str | -True | -- | - | Value of the filter key. |
-
all_pages | -bool | -- | False | -- | Indicates whether to return all available entities on the storage system. If set to True, the Info module will implement pagination and return all entities. Otherwise, a maximum of the first 100 entities of any type will be returned. |
- |
array_ip | -str | -True | -- | - | IP or FQDN of the PowerStore management system. |
- |
verifycert | -bool | -True | -- |
|
- Boolean variable to specify whether to validate SSL certificate or not. True - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS_CA_BUNDLE to the path of the SSL certificate. False - indicates that the SSL certificate should not be verified. |
- |
user | -str | -True | -- | - | The username of the PowerStore host. |
- |
password | -str | -True | -- | - | The password of the PowerStore host. |
- |
timeout | -int | -- | 120 | -- | Time after which the connection will get terminated. It is to be mentioned in seconds. |
- |
port | -int | -- | - | - | Port number for the PowerStore array. If not passed, it will take 443 as default. |
-
Key | -Type | -Returned | -Description | -|
---|---|---|---|---|
ActiveDirectory | -list | -When ad is in a given gather_subset | -Provides details of all active directories. | -|
- | id | -str | -success | -ID of the active directory. | -
Appliance | -list | -When appliance is in a given gather_subset | -Provides details of all appliances. | -|
- | id | -str | -success | -ID of the appliance. | -
- | model | -str | -success | -Model type of the PowerStore. | -
- | name | -str | -success | -Name of the appliance. | -
Array_Software_Version | -str | -always | -API version of PowerStore array. | -|
Certificate | -list | -When certificates is in a given gather_subset | -Provides details of all certificates. | -|
- | id | -str | -success | -ID of the certificate. | -
Cluster | -list | -always | -Provides details of all clusters. | -|
- | id | -str | -success | -ID of the cluster. | -
- | name | -str | -success | -Name of the cluster. | -
DNS | -list | -When dns is in a given gather_subset | -Provides details of all DNS servers. | -|
- | id | -str | -success | -ID of the DNS server. | -
EmailNotification | -list | -When email_notification is in a given gather_subset | -Provides details of all emails to which notifications will be sent. | -|
- | email_address | -str | -success | -Email address. | -
- | id | -str | -success | -ID of the email. | -
FileSystems | -list | -When file_system is in a given gather_subset | -Provides details of all filesystems. | -|
- | id | -str | -success | -ID of the filesystem. | -
- | name | -str | -success | -Name of the filesystem. | -
HostGroups | -list | -When hg is in a given gather_subset | -Provides details of all host groups. | -|
- | id | -str | -success | -ID of the host group. | -
- | name | -str | -success | -Name of the host group. | -
Hosts | -list | -When host is in a given gather_subset | -Provides details of all hosts. | -|
- | id | -str | -success | -ID of the host. | -
- | name | -str | -success | -Name of the host. | -
LDAP | -list | -When ldap is in a given gather_subset | -Provides details of all LDAPs. | -|
- | id | -str | -success | -ID of the LDAP. | -
LDAPAccounts | -list | -When LDAP account is in a given gather_subset | -Provides details of all LDAP accounts. | -|
- | dn | -str | -success | -Types of directory service protocol. | -
- | domain_id | -int | -success | -Unique identifier of the LDAP domain to which LDAP user or group belongs. | -
- | id | -str | -success | -ID of the LDAP account. | -
- | name | -str | -success | -Name of the LDAP account. | -
- | role_id | -int | -success | -Unique identifier of the role to which the LDAP account is mapped. | -
- | type | -str | -success | -Type of LDAP account. | -
LDAPDomain | -list | -When LDAP domain configuration is in a given gather_subset | -Provides details of the LDAP domain configurations. | -|
- | bind_user | -str | -success | -Distinguished Name (DN) of the user to be used when binding. | -
- | domain_name | -str | -success | -Name of the LDAP authority to construct the LDAP server configuration. | -
- | group_member_attribute | -str | -success | -Name of the LDAP attribute whose value contains the names of group members within a group. | -
- | group_name_attribute | -str | -success | -Name of the LDAP attribute whose value indicates the group name. | -
- | group_object_class | -str | -success | -LDAP object class for groups. | -
- | group_search_level | -int | -success | -Nested search level for performing group search. | -
- | group_search_path | -str | -success | -Path used to search for groups on the directory server. | -
- | id | -str | -success | -Unique identifier of the new LDAP server configuration. | -
- | is_global_catalog | -bool | -success | -Whether or not the catalog is global. Default value is false. | -
- | ldap_server_type | -str | -success | -Types of LDAP server. | -
- | ldap_server_type_l10n | -str | -success | -Localized message string corresponding to ldap_server_type. | -
- | ldap_servers | -list | -success | -List of IP addresses of the LDAP servers for the domain. IP addresses are in IPv4 format. | -
- | ldap_timeout | -int | -success | -Timeout for establishing a connection to an LDAP server. Default value is 30000 (30 seconds). | -
- | port | -int | -success | -Port number used to connect to the LDAP server(s). | -
- | protocol | -str | -success | -Types of directory service protocol. | -
- | protocol_l10n | -str | -success | -Localized message string corresponding to protocol. | -
- | user_id_attribute | -str | -success | -Name of the LDAP attribute whose value indicates the unique identifier of the user. | -
- | user_object_class | -str | -success | -LDAP object class for users. | -
- | user_search_path | -str | -success | -Path used to search for users on the directory server. | -
LocalUsers | -list | -When user is in a given gather_subset | -Provides details of all local users. | -|
- | id | -str | -success | -ID of the user. | -
- | name | -str | -success | -Name of the user. | -
NASServers | -list | -When nas_server is in a given gather_subset | -Provides details of all nas servers. | -|
- | id | -str | -success | -ID of the nas server. | -
- | name | -str | -success | -Name of the nas server. | -
NFSExports | -list | -When nfs_export is in a given gather_subset | -Provides details of all nfs exports. | -|
- | id | -str | -success | -ID of the nfs export. | -
- | name | -str | -success | -Name of the nfs export. | -
NTP | -list | -When ntp is in a given gather_subset | -Provides details of all NTP servers. | -|
- | id | -str | -success | -ID of the NTP server. | -
Networks | -list | -When network is in a given gather_subset | -Provides details of all networks. | -|
- | id | -str | -success | -ID of the network. | -
- | name | -str | -success | -Name of the network. | -
Nodes | -list | -When a node is in a given gather_subset | -Provides details of all nodes. | -|
- | id | -str | -success | -ID of the node. | -
- | name | -str | -success | -Name of the node. | -
ProtectionPolicies | -list | -When protection_policy is in a given gather_subset | -Provides details of all protection policies. | -|
- | id | -str | -success | -ID of the protection policy. | -
- | name | -str | -success | -Name of the protection policy. | -
RemoteSupport | -list | -When remote_support is in a given gather_subset | -Provides details of all remote support config. | -|
- | id | -str | -success | -ID of the remote support. | -
RemoteSupportContact | -list | -When remote_support_contact is in a given gather_subset | -Provides details of all remote support contacts. | -|
- | id | -str | -success | -ID of the remote support contact. | -
RemoteSystems | -list | -When remote_system is in a given gather_subset | -Provides details of all remote systems. | -|
- | id | -str | -success | -ID of the remote system. | -
- | name | -str | -success | -Name of the remote system. | -
ReplicationRules | -list | -When replication_rule is in a given gather_subset | -Provides details of all replication rules. | -|
- | id | -str | -success | -ID of the replication rule. | -
- | name | -str | -success | -Name of the replication rule. | -
ReplicationSession | -list | -when replication_session given in gather_subset | -Details of all replication sessions. | -|
- | id | -str | -success | -ID of the replication session. | -
Roles | -list | -When role is in a given gather_subset | -Provides details of all roles. | -|
- | id | -str | -success | -ID of the role. | -
- | name | -str | -success | -Name of the role. | -
SMBShares | -list | -When smb_share is in a given gather_subset | -Provides details of all smb shares. | -|
- | id | -str | -success | -ID of the smb share. | -
- | name | -str | -success | -name of the smb share. | -
SMTPConfig | -list | -When smtp_config is in a given gather_subset | -Provides details of all smtp config. | -|
- | id | -str | -success | -ID of the smtp config. | -
SecurityConfig | -list | -When security_config is in a given gather_subset | -Provides details of all security configs. | -|
- | id | -str | -success | -ID of the security config. | -
SnapshotRules | -list | -When snapshot_rule is in a given gather_subset | -Provides details of all snapshot rules. | -|
- | id | -str | -success | -ID of the snapshot rule. | -
- | name | -str | -success | -Name of the snapshot rule. | -
TreeQuotas | -list | -When tree_quota is in a given gather_subset | -Provides details of all tree quotas. | -|
- | id | -str | -success | -ID of the tree quota. | -
- | path | -str | -success | -Path of the tree quota. | -
UserQuotas | -list | -When user_quota is in a given gather_subset | -Provides details of all user quotas. | -|
- | id | -str | -success | -ID of the user quota. | -
VolumeGroups | -list | -When vg is in a given gather_subset | -Provides details of all volume groups. | -|
- | id | -str | -success | -ID of the volume group. | -
- | name | -str | -success | -Name of the volume group. | -
Volumes | -list | -When vol is in a given gather_subset | -Provides details of all volumes. | -|
- | id | -str | -success | -ID of the volume. | -
- | name | -str | -success | -Name of the volume. | -
changed | -bool | -always | -Shows whether or not the resource has changed. | -
Parameter | -Type | -Required | -Default | -Choices | -Description | -
---|---|---|---|---|---|
job_id | -str | -True | -- | - | The ID of the job. |
-
array_ip | -str | -True | -- | - | IP or FQDN of the PowerStore management system. |
-
verifycert | -bool | -True | -- |
|
- Boolean variable to specify whether to validate SSL certificate or not. True - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS_CA_BUNDLE to the path of the SSL certificate. False - indicates that the SSL certificate should not be verified. |
-
user | -str | -True | -- | - | The username of the PowerStore host. |
-
password | -str | -True | -- | - | The password of the PowerStore host. |
-
timeout | -int | -- | 120 | -- | Time after which the connection will get terminated. It is to be mentioned in seconds. |
-
port | -int | -- | - | - | Port number for the PowerStore array. If not passed, it will take 443 as default. |
-
Key | -Type | -Returned | -Description | -|||
---|---|---|---|---|---|---|
changed | -bool | -always | -Whether or not the resource has changed. | -|||
job_details | -complex | -When job exists. | -The job details. | -|||
- | description_l10n | -str | -success | -Description of the job. | -||
- | end_time | -str | -success | -Date and time when the job execution completed. | -||
- | estimated_completion_time | -str | -success | -Estimated completion date and time. | -||
- | id | -str | -success | -Unique identifier of the job. | -||
- | parent_id | -str | -success | -Unique identifier of the parent job, if applicable. | -||
- | phase | -str | -success | -Current status of the job. | -||
- | progress_percentage | -int | -success | -Percent complete of the job. | -||
- | resource_action | -str | -success | -User-specified action to be performed on the given resource. | -||
- | resource_id | -str | -success | -Unique identifier of the resource on which the job is operating. | -||
- | resource_name | -str | -success | -Name of the resource on which the job is operating. | -||
- | resource_type | -str | -success | -Resource Type for the given resource. | -||
- | response_body | -complex | -success | -Base response object. | -||
- | - | messages | -complex | -success | -The details of the error response. | -|
- | - | - | arguments | -list | -success | -Values involved in the error. | -
- | - | - | code | -str | -success | -Hexadecimal code of the error. | -
- | - | - | message_l10n | -str | -success | -The description of the error. | -
- | - | - | severity | -str | -success | -Type of the severity. | -
- | - | response_type | -str | -success | -Job error response. | -|
- | response_status | -str | -success | -Possible HTTP status values of completed or failed jobs. | -||
- | root_id | -str | -success | -Unique identifier of the root job, if applicable. The root job is the job at the top of the parent hierarchy. | -||
- | start_time | -str | -success | -Date and time when the job execution started. | -||
- | state | -str | -success | -Current status of the job. | -||
- | step_order | -int | -success | -Order of a given job step with respect to its siblings within the job hierarchy. | -||
- | user | -str | -success | -Name of the user associated with the job. | -
Parameter | -Type | -Required | -Default | -Choices | -Description | -
---|---|---|---|---|---|
ldap_account_id | -int | -- | - | - | Unique identifier of the LDAP account. |
-
ldap_account_name | -str | -- | - | - | Name of the new LDAP account to be created. This has to match to the LDAP user or group in LDAP server to which the LDAP account is mapped. |
-
ldap_domain_id | -int | -- | - | - | Unique identifier of the LDAP domain to which LDAP user or group belongs. |
-
ldap_domain_name | -str | -- | - | - | Name of the LDAP domain to which LDAP user or group belongs. |
-
role_id | -int | -- | - | - | Unique identifier of the role to which the new LDAP account will be mapped. |
-
role_name | -str | -- | - | - | Name of the role to which the new LDAP account will be mapped. |
-
ldap_account_type | -str | -- | - |
|
- Type of LDAP account. |
-
state | -str | -True | -- |
|
- Define whether the LDAP account should exist or not. For Delete operation only, it should be set to "absent". For all other operations except delete, it should be set to "present". |
-
array_ip | -str | -True | -- | - | IP or FQDN of the PowerStore management system. |
-
verifycert | -bool | -True | -- |
|
- Boolean variable to specify whether to validate SSL certificate or not. True - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS_CA_BUNDLE to the path of the SSL certificate. False - indicates that the SSL certificate should not be verified. |
-
user | -str | -True | -- | - | The username of the PowerStore host. |
-
password | -str | -True | -- | - | The password of the PowerStore host. |
-
timeout | -int | -- | 120 | -- | Time after which the connection will get terminated. It is to be mentioned in seconds. |
-
port | -int | -- | - | - | Port number for the PowerStore array. If not passed, it will take 443 as default. |
-
Key | -Type | -Returned | -Description | -|
---|---|---|---|---|
changed | -bool | -always | -Whether or not the resource has changed. | -|
ldap_account_details | -complex | -When LDAP account exists. | -Details of the LDAP account. | -|
- | dn | -str | -success | -Types of directory service protocol. | -
- | domain_id | -int | -success | -Unique identifier of the LDAP domain to which LDAP user or group belongs. | -
- | id | -int | -success | -Unique identifier of the LDAP account. | -
- | name | -str | -success | -Name of the LDAP account. | -
- | role_id | -int | -success | -Unique identifier of the role to which the LDAP account is mapped. | -
- | type | -str | -success | -Type of LDAP account. | -
Parameter | -Type | -Required | -Default | -Choices | -Description | -|
---|---|---|---|---|---|---|
ldap_domain_name | -str | -- | - | - | Name of the LDAP authority to construct the LDAP server configuration. Mandatory for the create operation. |
- |
ldap_domain_id | -int | -- | - | - | Unique identifier of the LDAP domain configuration. |
- |
ldap_servers | - list elements: str |
- - | - | - | List of IP addresses of the LDAP servers for the domain. |
- |
ldap_server_state | -str | -- | - |
|
- State of the LDAP server. The ldap_servers and ldap_server_state are required together. |
- |
ldap_server_port | -int | -- | - | - | Port number used to connect to the LDAP Server. |
- |
protocol | -str | -- | - |
|
- Types of directory service protocol. |
- |
ldap_server_type | -str | -- | - |
|
- Types of the LDAP server. |
- |
bind_user | -str | -- | - | - | Distinguished Name (DN) of the user to be used when binding; that is, authenticating and setting up the connection to the LDAP server. Mandatory for the create operation. |
- |
bind_password | -str | -- | - | - | Password to use when binding a new LDAP session. Mandatory for the create operation. |
- |
ldap_timeout | -int | -- | - | - | Timeout for establishing a connection to an LDAP server. |
- |
is_global_catalog | -bool | -- | - | - | Whether or not the catalog is global. |
- |
ldap_domain_user_settings | -dict | -- | - | - | User settings of LDAP domain. |
- |
- | user_id_attribute | -str | -- | - | - | Name of the LDAP attribute whose value indicates the unique identifier of the user. Default value is sAMAccountName. |
-
- | user_object_class | -str | -- | - | - | LDAP object class for users. Default value is user. |
-
- | user_search_path | -str | -- | - | - | Path used to search for users on the directory server. Search path is empty, if global catalog is enabled. |
-
ldap_domain_group_settings | -dict | -- | - | - | Group settings of LDAP domain. |
- |
- | group_name_attribute | -str | -- | - | - | Name of the LDAP attribute whose value indicates the group name. Default value is cn. |
-
- | group_member_attribute | -str | -- | - | - | Name of the LDAP attribute whose value contains the names of group members within a group. Default value is member. |
-
- | group_object_class | -str | -- | - | - | LDAP object class for groups. Default value is group. |
-
- | group_search_path | -str | -- | - | - | Path used to search for groups on the directory server. Search path is empty, if global catalog is enabled. |
-
- | group_search_level | -int | -- | - | - | Nested search level for performing group search. Default value is 0. |
-
verify_configuration | -bool | -- | False | -- | Indicates whether to perform the verify LDAP domain configuration or not. |
- |
state | -str | -True | -- |
|
- Define whether the LDAP domain configuration should exist or not. For Delete operation only, it should be set to "absent". For all other operations except delete, it should be set to "present". |
- |
array_ip | -str | -True | -- | - | IP or FQDN of the PowerStore management system. |
- |
verifycert | -bool | -True | -- |
|
- Boolean variable to specify whether to validate SSL certificate or not. True - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS_CA_BUNDLE to the path of the SSL certificate. False - indicates that the SSL certificate should not be verified. |
- |
user | -str | -True | -- | - | The username of the PowerStore host. |
- |
password | -str | -True | -- | - | The password of the PowerStore host. |
- |
timeout | -int | -- | 120 | -- | Time after which the connection will get terminated. It is to be mentioned in seconds. |
- |
port | -int | -- | - | - | Port number for the PowerStore array. If not passed, it will take 443 as default. |
-
Key | -Type | -Returned | -Description | -|
---|---|---|---|---|
changed | -bool | -always | -Whether or not the resource has changed. | -|
ldap_domain_details | -complex | -When LDAP domain configuration exists. | -Details of the LDAP domain configuration. | -|
- | bind_user | -str | -success | -Distinguished Name (DN) of the user to be used when binding. | -
- | domain_name | -str | -success | -Name of the LDAP authority to construct the LDAP server configuration. | -
- | group_member_attribute | -str | -success | -Name of the LDAP attribute whose value contains the names of group members within a group. | -
- | group_name_attribute | -str | -success | -Name of the LDAP attribute whose value indicates the group name. | -
- | group_object_class | -str | -success | -LDAP object class for groups. | -
- | group_search_level | -int | -success | -Nested search level for performing group search. | -
- | group_search_path | -str | -success | -Path used to search for groups on the directory server. | -
- | id | -str | -success | -Unique identifier of the new LDAP server configuration. | -
- | is_global_catalog | -bool | -success | -Whether or not the catalog is global. Default value is false. | -
- | ldap_server_type | -str | -success | -Types of LDAP server. | -
- | ldap_server_type_l10n | -str | -success | -Localized message string corresponding to ldap_server_type. | -
- | ldap_servers | -list | -success | -List of IP addresses of the LDAP servers for the domain. IP addresses are in IPv4 format. | -
- | ldap_timeout | -int | -success | -Timeout for establishing a connection to an LDAP server. Default value is 30000 (30 seconds). | -
- | port | -int | -success | -Port number used to connect to the LDAP server(s). | -
- | protocol | -str | -success | -Types of directory service protocol. | -
- | protocol_l10n | -str | -success | -Localized message string corresponding to protocol. | -
- | user_id_attribute | -str | -success | -Name of the LDAP attribute whose value indicates the unique identifier of the user. | -
- | user_object_class | -str | -success | -LDAP object class for users. | -
- | user_search_path | -str | -success | -Path used to search for users on the directory server. | -
Parameter | -Type | -Required | -Default | -Choices | -Description | -
---|---|---|---|---|---|
user_name | -str | -- | - | - | Name of the local user account. Mutually exclusive with user_id. Mandatory only for create operation. |
-
user_id | -str | -- | - | - | Unique identifier of the local user account. Mutually exclusive with user_name. |
-
user_password | -str | -- | - | - | Password for the new local user account to be created. Mandatory only for create operation. |
-
new_password | -str | -- | - | - | New password for the existing local user account. |
-
role_name | -str | -- | - | - | The name of the role to which the local user account will be mapped. It is mutually exclusive with role_id. |
-
role_id | -int | -- | - | - | The unique identifier of the role to which the local user account will be mapped. It is mutually exclusive with role_name. |
-
is_locked | -bool | -- | - | - | Whether the user account is locked or not. Defaults to false at creation time. |
-
state | -str | -True | -- |
|
- Define whether the local user should exist or not. |
-
array_ip | -str | -True | -- | - | IP or FQDN of the PowerStore management system. |
-
verifycert | -bool | -True | -- |
|
- Boolean variable to specify whether to validate SSL certificate or not. True - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS_CA_BUNDLE to the path of the SSL certificate. False - indicates that the SSL certificate should not be verified. |
-
user | -str | -True | -- | - | The username of the PowerStore host. |
-
password | -str | -True | -- | - | The password of the PowerStore host. |
-
timeout | -int | -- | 120 | -- | Time after which the connection will get terminated. It is to be mentioned in seconds. |
-
port | -int | -- | - | - | Port number for the PowerStore array. If not passed, it will take 443 as default. |
-
Key | -Type | -Returned | -Description | -|
---|---|---|---|---|
changed | -bool | -always | -Whether or not the resource has changed. | -|
local_user_details | -complex | -When local user exists | -Details of the local user. | -|
- | id | -str | -success | -The system generated ID given to the local user. | -
- | is_built_in | -bool | -success | -Whether the user account is built-in or not. | -
- | is_default_password | -bool | -success | -Whether the user account has a default password or not. Only applies to default user accounts | -
- | is_locked | -bool | -success | -Whether the user account is locked or not. Defaults to false at creation time. | -
- | name | -str | -success | -Name of the local user. | -
- | role_id | -str | -success | -Unique identifier of the role local user account is mapped to. | -
- | role_name | -str | -success | -Name of the role to which local user account is mapped. | -
Parameter | -Type | -Required | -Default | -Choices | -Description | -
---|---|---|---|---|---|
nas_server_name | -str | -- | - | - | Name of the NAS server. Mutually exclusive with nas_server_id. |
-
nas_server_id | -str | -- | - | - | Unique id of the NAS server. Mutually exclusive with nas_server_name. |
-
description | -str | -- | - | - | Description of the NAS server. |
-
nas_server_new_name | -str | -- | - | - | New name of the NAS server for a rename operation. |
-
current_node | -str | -- | - | - | Unique identifier or name of the node on which the NAS server is running. |
-
preferred_node | -str | -- | - | - | Unique identifier or name of the preferred node for the NAS server. The initial value (on NAS server create) is taken from the current node. |
-
current_unix_directory_service | -str | -- | - |
|
- Define the Unix directory service used for looking up identity information for Unix such as UIDs, GIDs, net groups, and so on. |
-
default_unix_user | -str | -- | - | - | Default Unix user name used for granting access in case of Windows to Unix user mapping failure. When empty, access in such case is denied. |
-
default_windows_user | -str | -- | - | - | Default Windows user name used for granting access in case of Unix to Windows user mapping failure. When empty, access in such case is denied. |
-
protection_policy | -str | -- | - | - | Name/ID of the protection policy applied to the nas server. Policy can be removed by passing an empty string in the protection_policy parameter. |
-
state | -str | -True | -- |
|
- Define whether the nas server should exist or not. |
-
array_ip | -str | -True | -- | - | IP or FQDN of the PowerStore management system. |
-
verifycert | -bool | -True | -- |
|
- Boolean variable to specify whether to validate SSL certificate or not. True - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS_CA_BUNDLE to the path of the SSL certificate. False - indicates that the SSL certificate should not be verified. |
-
user | -str | -True | -- | - | The username of the PowerStore host. |
-
password | -str | -True | -- | - | The password of the PowerStore host. |
-
timeout | -int | -- | 120 | -- | Time after which the connection will get terminated. It is to be mentioned in seconds. |
-
port | -int | -- | - | - | Port number for the PowerStore array. If not passed, it will take 443 as default. |
-
Key | -Type | -Returned | -Description | -|
---|---|---|---|---|
changed | -bool | -always | -Whether or not the resource has changed. | -|
nasserver_details | -complex | -When nas server exists | -Details about the nas server. | -|
- | backup_IPv4_interface_id | -str | -success | -Unique identifier of the preferred IPv4 backup interface. | -
- | backup_IPv6_interface_id | -str | -success | -Unique identifier of the preferred IPv6 backup interface. | -
- | current_node | -dict | -success | -Unique identifier and name of the node on which the NAS server is running. | -
- | current_unix_directory_service | -str | -success | -Define the Unix directory service used for looking up identity information for Unix such as UIDs, GIDs, net groups, and so on. | -
- | default_unix_user | -str | -success | -Default Unix user name used for granting access in case of Windows to Unix user mapping failure. | -
- | description | -str | -success | -Additional information about the nas server. | -
- | file_interfaces | -dict | -success | -This is the inverse of the resource type file_interface association. Will return the id,name & ip_address of the associated file interface. | -
- | file_ldaps | -str | -success | -This is the inverse of the resource type file_ldap association. | -
- | file_systems | -dict | -success | -This is the inverse of the resource type file_system association. | -
- | id | -str | -success | -The system generated ID given to the nas server. | -
- | is_username_translation_enabled | -bool | -success | -Enable the possibility to match a windows account to a Unix account with different names. | -
- | name | -str | -success | -Name of the nas server. | -
- | nfs_servers | -str | -success | -This is the inverse of the resource type nfs_server association. | -
- | operational_status | -str | -success | -NAS server operational status. | -
- | preferred_node | -dict | -success | -Unique identifier and name of the preferred node for the NAS server. | -
- | production_IPv4_interface_id | -str | -success | -Unique identifier of the preferred IPv4 production interface. | -
- | production_IPv6_interface_id | -str | -success | -Unique identifier of the preferred IPv6 production interface. | -
- | protection_policy_id | -str | -success | -Id of the protection policy applied to the nas server. | -
- | smb_servers | -str | -success | -This is the inverse of the resource type smb_server association. | -
Parameter | -Type | -Required | -Default | -Choices | -Description | -|
---|---|---|---|---|---|---|
network_name | -str | -- | - | - | The name of the network. This parameter is added in 2.0.0.0. Specify either network_name or network_id for any operation. |
- |
network_id | -str | -- | - | - | The ID of the network. |
- |
vlan_id | -int | -- | - | - | The ID of the VLAN. |
- |
gateway | -str | -- | - | - | Network gateway in IPv4 format. IP version. Specify empty string to remove the gateway. |
- |
prefix_length | -int | -- | - | - | Network prefix length. |
- |
new_cluster_mgmt_address | -str | -- | - | - | New cluster management IP address in IPv4 format. |
- |
storage_discovery_address | -str | -- | - | - | New storage discovery IP address in IPv4 format. Specify empty string to remove the storage discovery IP address. |
- |
mtu | -int | -- | - | - | Maximum Transmission Unit (MTU) packet size set on network interfaces, in bytes. |
- |
new_name | -str | -- | - | - | New name of the network. |
- |
addresses | - list elements: dict |
- - | - | - | IP addresses to add/remove in IPv4 format. |
- |
- | current_address | -str | -- | - | - | Existing IPv4 address. |
-
- | new_address | -str | -- | - | - | New IPv4 address. |
-
ports | - list elements: str |
- - | - | - | Ports to be mapped/unmapped to/from the storage network. |
- |
port_state | -str | -- | - |
|
- Specifies whether port should mapped/unmapped from the storage network. |
- |
vasa_provider_credentials | -dict | -- | - | - | Credentials required for re-registering the VASA vendor provider during the reconfiguration of the cluster management IP address. |
- |
- | username | -str | -True | -- | - | VASA vendor provider user name. |
-
- | password | -str | -True | -- | - | VASA vendor provider password. |
-
esxi_credentials | - list elements: dict |
- - | - | - | Credentials required for re-registering the ESXi hosts in the vCenter. It should be passed only when ESXi host addresses or management network VLAN / prefix / gateway are changed during the reconfiguration of the PowerStore X model appliances. This parameter is applicable only for PowerStore X model. This parameter will be ignored if passed for PowerStore T model. |
- |
- | node_id | -str | -True | -- | - | Node identifier corresponding to the ESXi host. |
-
- | password | -str | -True | -- | - | ESXi host root password. |
-
wait_for_completion | -bool | -- | False | -- | Flag to indicate if the operation should be run synchronously or asynchronously. True signifies synchronous execution. By default, modify operation will run asynchronously. |
- |
state | -str | -True | -- |
|
- Define whether the network exist or not. |
- |
array_ip | -str | -True | -- | - | IP or FQDN of the PowerStore management system. |
- |
verifycert | -bool | -True | -- |
|
- Boolean variable to specify whether to validate SSL certificate or not. True - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS_CA_BUNDLE to the path of the SSL certificate. False - indicates that the SSL certificate should not be verified. |
- |
user | -str | -True | -- | - | The username of the PowerStore host. |
- |
password | -str | -True | -- | - | The password of the PowerStore host. |
- |
timeout | -int | -- | 120 | -- | Time after which the connection will get terminated. It is to be mentioned in seconds. |
- |
port | -int | -- | - | - | Port number for the PowerStore array. If not passed, it will take 443 as default. |
-
Key | -Type | -Returned | -Description | -||||
---|---|---|---|---|---|---|---|
changed | -bool | -always | -Whether or not the resource has changed. | -||||
job_details | -complex | -When asynchronous task is performed. | -The job details. | -||||
- | id | -str | -success | -The ID of the job. | -|||
network_details | -complex | -When network exists. | -The network details. | -||||
- | cluster_details | -complex | -success | -The details of the cluster. | -|||
- | - | appliance_count | -int | -success | -Number of appliances configured in this cluster. | -||
- | - | id | -str | -success | -The unique identifier of the cluster. | -||
- | - | management_address | -str | -success | -The floating management IP address for the cluster in IPv4 or IPv6 format. | -||
- | - | name | -str | -success | -The name of the cluster. | -||
- | - | storage_discovery_address | -str | -success | -The floating storage discovery IP address for the cluster in IPv4 or IPv6 format. | -||
- | gateway | -str | -success | -The gateway of the network. | -|||
- | id | -str | -success | -The ID of the network. | -|||
- | ip_version | -str | -success | -IP protocol version | -|||
- | member_ips | -complex | -success | -Properties of the IP pool address. | -|||
- | - | address | -str | -success | -IP address value, in IPv4 or IPv6 format. | -||
- | - | appliance_id | -str | -success | -Unique identifier of the appliance to which the IP address belongs. | -||
- | - | id | -str | -success | -Unique identifier of the IP address. | -||
- | - | ip_port_id | -str | -success | -Unique identifier of the port that uses this IP address to provide access to storage network services, such as iSCSI. This attribute can be set only for an IP address used by networks of type Storage. | -||
- | - | name | -str | -success | -Name of the IP address. | -||
- | - | network_id | -str | -success | -Unique identifier of the network to which the IP address belongs. | -||
- | - | node_id | -str | -success | -Unique identifier of the cluster node to which the IP address belongs. | -||
- | - | purposes | -list | -success | -IP address purposes. | -||
- | mtu | -int | -success | -Maximum Transmission Unit (MTU) packet size set on network interfaces, in bytes. | -|||
- | name | -str | -success | -The name of the network. | -|||
- | prefix_length | -int | -success | -Network prefix length. | -|||
- | purposes | -list | -success | -Purposes of the network. | -|||
- | type | -str | -success | -Network type | -|||
- | vcenter_details | -complex | -success | -Details of the vcenter. | -|||
- | - | address | -str | -success | -IP address of vCenter host, in IPv4, IPv6, or hostname format. | -||
- | - | id | -str | -success | -Unique identifier of the vCenter instance. | -||
- | - | instance_uuid | -str | -success | -UUID instance of the vCenter. | -||
- | - | username | -str | -success | -User name to login to vCenter. | -||
- | - | vendor_provider_status | -str | -success | -General status of the VASA vendor provider in vCenter. | -||
- | vlan_id | -int | -success | -VLAN identifier. | -
Parameter | -Type | -Required | -Default | -Choices | -Description | -
---|---|---|---|---|---|
nfs_export_name | -str | -- | - | - | The name of the NFS export. Mandatory for create operation. Specify either nfs_export_name or nfs_export_id(but not both) for any operation. |
-
nfs_export_id | -str | -- | - | - | The ID of the NFS export. |
-
filesystem | -str | -- | - | - | The ID/Name of the filesystem for which the NFS export will be created. Either filesystem or snapshot is required for creation of the NFS Export. If filesystem name is specified, then nas_server is required to uniquely identify the filesystem. If filesystem parameter is provided, then snapshot cannot be specified. |
-
snapshot | -str | -- | - | - | The ID/Name of the Snapshot for which NFS export will be created. Either filesystem or snapshot is required for creation of the NFS Export. If snapshot name is specified, then nas_server is required to uniquely identify the snapshot. If snapshot parameter is provided, then filesystem cannot be specified. NFS export can be created only if access type of snapshot is "protocol". |
-
nas_server | -str | -- | - | - | The NAS server. This could be the name or ID of the NAS server. |
-
path | -str | -- | - | - | Local path to export relative to the NAS server root. With NFS, each export of a file_system or file_snap must have a unique local path. Mandatory while creating NFS export. |
-
description | -str | -- | - | - | The description for the NFS export. |
-
default_access | -str | -- | - |
|
- Default access level for all hosts that can access the Export. For hosts that need different access than the default, they can be configured by adding to the list. If default_access is not mentioned during creation, then NFS export will be created with No_Access. |
-
no_access_hosts | - list elements: str |
- - | - | - | Hosts with no access to the NFS export. |
-
read_only_hosts | - list elements: str |
- - | - | - | Hosts with read-only access to the NFS export. |
-
read_only_root_hosts | - list elements: str |
- - | - | - | Hosts with read-only access for root user to the NFS export. |
-
read_write_hosts | - list elements: str |
- - | - | - | Hosts with read and write access to the NFS export. |
-
read_write_root_hosts | - list elements: str |
- - | - | - | Hosts with read and write access for root user to the NFS export. |
-
min_security | -str | -- | - |
|
- NFS enforced security type for users accessing an NFS export. If not specified at the time of creation, it will be set to SYS. |
-
anonymous_uid | -int | -- | - | - | Specifies the user ID of the anonymous account. If not specified at the time of creation, it will be set to -2. |
-
anonymous_gid | -int | -- | - | - | Specifies the group ID of the anonymous account. If not specified at the time of creation, it will be set to -2. |
-
is_no_suid | -bool | -- | - | - | If set, do not allow access to set SUID. Otherwise, allow access. If not specified at the time of creation, it will be set to False. |
-
host_state | -str | -- | - |
|
- Define whether the hosts can access the NFS export. Required when adding or removing host access from the export. |
-
state | -str | -True | -- |
|
- Define whether the NFS export should exist or not. |
-
array_ip | -str | -True | -- | - | IP or FQDN of the PowerStore management system. |
-
verifycert | -bool | -True | -- |
|
- Boolean variable to specify whether to validate SSL certificate or not. True - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS_CA_BUNDLE to the path of the SSL certificate. False - indicates that the SSL certificate should not be verified. |
-
user | -str | -True | -- | - | The username of the PowerStore host. |
-
password | -str | -True | -- | - | The password of the PowerStore host. |
-
timeout | -int | -- | 120 | -- | Time after which the connection will get terminated. It is to be mentioned in seconds. |
-
port | -int | -- | - | - | Port number for the PowerStore array. If not passed, it will take 443 as default. |
-
Key | -Type | -Returned | -Description | -|||
---|---|---|---|---|---|---|
changed | -bool | -always | -Whether or not the resource has changed. | -|||
nfs_export_details | -complex | -When NFS export exists. | -The NFS export details. | -|||
- | anonymous_GID | -int | -success | -The group ID of the anonymous account. | -||
- | anonymous_UID | -int | -success | -The user ID of the anonymous account. | -||
- | default_access | -str | -success | -Default access level for all hosts that can access the export. | -||
- | description | -str | -success | -The description for the NFS export. | -||
- | file_system | -complex | -success | -Details of filesystem and NAS server on which NFS export is present. | -||
- | - | filesystem_type | -str | -success | -The type of the filesystem. | -|
- | - | id | -str | -success | -The ID of the filesystem. | -|
- | - | name | -str | -success | -The name of the filesystem. | -|
- | - | nas_server | -complex | -success | -Details of NAS server. | -|
- | - | - | id | -str | -success | -The ID of the NAS server. | -
- | - | - | name | -str | -success | -The name of the NAS server. | -
- | id | -str | -success | -The ID of the NFS export. | -||
- | is_no_SUID | -bool | -success | -If set, do not allow access to set SUID. Otherwise, allow access. | -||
- | min_security | -str | -success | -NFS enforced security type for users accessing an NFS export. | -||
- | name | -str | -success | -The name of the NFS export. | -||
- | no_access_hosts | -list | -success | -Hosts with no access to the NFS export. | -||
- | path | -str | -success | -Local path to a location within the file system. | -||
- | read_only_hosts | -list | -success | -Hosts with read-only access to the NFS export. | -||
- | read_only_root_hosts | -list | -success | -Hosts with read-only for root user access to the NFS export. | -||
- | read_write_hosts | -list | -success | -Hosts with read and write access to the NFS export. | -||
- | read_write_root_hosts | -list | -success | -Hosts with read and write for root user access to the NFS export. | -
Parameter | -Type | -Required | -Default | -Choices | -Description | -
---|---|---|---|---|---|
ntp_id | -str | -True | -- | - | Unique identifier of the NTP instance. |
-
ntp_addresses | - list elements: str |
- - | - | - | NTP server addresses, may contain host names or IPv4 addresses. |
-
ntp_address_state | -str | -- | - |
|
- State of the addresses mentioned in ntp_addresses. |
-
state | -str | -True | -- |
|
- The state of the NTP instance after the task is performed. For get and modify operations it should be set to "present". |
-
array_ip | -str | -True | -- | - | IP or FQDN of the PowerStore management system. |
-
verifycert | -bool | -True | -- |
|
- Boolean variable to specify whether to validate SSL certificate or not. True - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS_CA_BUNDLE to the path of the SSL certificate. False - indicates that the SSL certificate should not be verified. |
-
user | -str | -True | -- | - | The username of the PowerStore host. |
-
password | -str | -True | -- | - | The password of the PowerStore host. |
-
timeout | -int | -- | 120 | -- | Time after which the connection will get terminated. It is to be mentioned in seconds. |
-
port | -int | -- | - | - | Port number for the PowerStore array. If not passed, it will take 443 as default. |
-
Key | -Type | -Returned | -Description | -|
---|---|---|---|---|
changed | -bool | -always | -Shows whether or not the resource has changed. | -|
ntp_details | -complex | -When NTP exists. | -Details of the NTP instance. | -|
- | addresses | -str | -success | -NTP server addresses, may contain host names or IPv4 addresses. | -
- | id | -str | -success | -Unique identifier of NTP instance. | -
Parameter | -Type | -Required | -Default | -Choices | -Description | -
---|---|---|---|---|---|
name | -str | -- | - | - | String variable. Indicates the name of the protection policy. |
-
protectionpolicy_id | -str | -- | - | - | String variable. Indicates the id of the protection policy. |
-
new_name | -str | -- | - | - | String variable. Indicates the new name of the protection policy. Used for renaming operation. |
-
snapshotrules | - list elements: str |
- - | - | - | List of strings to specify the name or ids of snapshot rules which are to be added or removed, to or from, the protection policy. |
-
replicationrule | -str | -- | - | - | The name or ids of the replcation rule which is to be added to the protection policy. To remove the replication rule, an empty string has to be passed. |
-
description | -str | -- | - | - | String variable. Indicates the description of the protection policy. |
-
state | -str | -True | -- |
|
- String variable. Indicates the state of protection policy. For Delete operation only, it should be set to "absent". For all other operations like Create, Modify or Get details, it should be set to "present". |
-
snapshotrule_state | -str | -- | - |
|
- String variable. Indicates the state of a snapshotrule in a protection policy. When snapshot rules are specified, this variable is required. Value present-in-policy indicates to add to protection policy. Value absent-in-policy indicates to remove from protection policy. |
-
array_ip | -str | -True | -- | - | IP or FQDN of the PowerStore management system. |
-
verifycert | -bool | -True | -- |
|
- Boolean variable to specify whether to validate SSL certificate or not. True - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS_CA_BUNDLE to the path of the SSL certificate. False - indicates that the SSL certificate should not be verified. |
-
user | -str | -True | -- | - | The username of the PowerStore host. |
-
password | -str | -True | -- | - | The password of the PowerStore host. |
-
timeout | -int | -- | 120 | -- | Time after which the connection will get terminated. It is to be mentioned in seconds. |
-
port | -int | -- | - | - | Port number for the PowerStore array. If not passed, it will take 443 as default. |
-
Key | -Type | -Returned | -Description | -|||
---|---|---|---|---|---|---|
changed | -bool | -always | -Whether or not the resource has changed. | -|||
protectionpolicy_details | -complex | -When protection policy exists | -Details of the protection policy. | -|||
- | description | -str | -success | -description about the protection policy. | -||
- | id | -str | -success | -The system generated ID given to the protection policy. | -||
- | name | -str | -success | -Name of the protection policy. | -||
- | replication_rules | -complex | -success | -The replication rule details of the protection policy. | -||
- | - | id | -str | -success | -The replication rule ID of the protection policy. | -|
- | - | name | -str | -success | -The replication rule name of the protection policy. | -|
- | snapshot_rules | -complex | -success | -The snapshot rules details of the protection policy. | -||
- | - | id | -str | -success | -The snapshot rule ID of the protection policy. | -|
- | - | name | -str | -success | -The snapshot rule name of the protection policy. | -|
- | type | -str | -success | -The type for the protection policy. | -
Parameter | -Type | -Required | -Default | -Choices | -Description | -|
---|---|---|---|---|---|---|
path | -str | -- | - | - | The path on which the quota will be imposed. Path is relative to the root of the filesystem. For user quota, if path is not specified, quota will be created at the root of the filesystem. |
- |
quota_type | -str | -- | - |
|
- The type of quota which will be imposed. |
- |
quota_id | -str | -- | - | - | Id of the user/tree quota. If quota_id is mentioned, then path/nas_server/file_system/quota_type is not required. |
- |
filesystem | -str | -- | - | - | The ID/Name of the filesystem for which the Tree/User Quota will be created. If filesystem name is specified, then nas_server is required to uniquely identify the filesystem. |
- |
nas_server | -str | -- | - | - | The NAS server. This could be the name or ID of the NAS server. |
- |
description | -str | -- | - | - | Additional information that can be mentioned for a Tree Quota. Description parameter can only be used when quota_type is 'tree'. |
- |
unix_name | -str | -- | - | - | The name of the unix user account for which quota operations will be performed. Any one among uid/unix_name/windows_name/windows_sid is required when quota_type is 'user'. |
- |
windows_name | -str | -- | - | - | The name of the Windows User for which quota operations will be performed. The name should be mentioned along with Domain Name as 'DOMAIN_NAME\user_name' or as "DOMAIN_NAME\\user_name". Any one among uid/unix_name/windows_name/windows_sid is required when quota_type is 'user'. |
- |
uid | -int | -- | - | - | The ID of the unix user account for which quota operations will be performed. Any one among uid/unix_name/windows_name/windows_sid is required when quota_type is 'user'. |
- |
windows_sid | -str | -- | - | - | The SID of the Windows User account for which quota operations will be performed. Any one among uid/unix_name/windows_name/windows_sid is required when quota_type is 'user'. |
- |
quota | -dict | -- | - | - | Specifies Quota parameters. |
- |
- | soft_limit | -int | -- | - | - | Soft limit of the User/Tree quota. No Soft limit when set to 0. |
-
- | hard_limit | -int | -- | - | - | Hard limit of the user quota. No hard limit when set to 0. |
-
- | cap_unit | -str | -- | GB | -
|
- Unit of storage for the hard and soft limits. This parameter is required if limit is specified. |
-
state | -str | -True | -- |
|
- Define whether the Quota should exist or not. Value present indicates that the Quota should exist on the system. Value absent indicates that the Quota should not exist on the system. |
- |
array_ip | -str | -True | -- | - | IP or FQDN of the PowerStore management system. |
- |
verifycert | -bool | -True | -- |
|
- Boolean variable to specify whether to validate SSL certificate or not. True - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS_CA_BUNDLE to the path of the SSL certificate. False - indicates that the SSL certificate should not be verified. |
- |
user | -str | -True | -- | - | The username of the PowerStore host. |
- |
password | -str | -True | -- | - | The password of the PowerStore host. |
- |
timeout | -int | -- | 120 | -- | Time after which the connection will get terminated. It is to be mentioned in seconds. |
- |
port | -int | -- | - | - | Port number for the PowerStore array. If not passed, it will take 443 as default. |
-
Key | -Type | -Returned | -Description | -|||
---|---|---|---|---|---|---|
changed | -bool | -always | -Whether or not the resource has changed. | -|||
quota_details | -complex | -When Quota exists. | -The quota details. | -|||
- | description | -str | -success | -Additional information about the tree quota. Only applicable for Tree Quotas. | -||
- | file_system | -complex | -success | -Includes ID and Name of filesystem and nas server for which smb share exists. | -||
- | - | filesystem_type | -str | -success | -Type of filesystem. | -|
- | - | id | -str | -success | -ID of filesystem. | -|
- | - | name | -str | -success | -Name of filesystem. | -|
- | - | nas_server | -dict | -success | -nas_server of filesystem. | -|
- | hard_limit(cap_unit) | -int | -success | -Value of the Hard Limit imposed on the quota. | -||
- | id | -str | -success | -The ID of the Quota. | -||
- | remaining_grace_period | -int | -success | -The time period remaining after which the grace period will expire. | -||
- | size_used | -int | -success | -Size currently consumed by Tree/User on the filesystem. | -||
- | soft_limit(cap_unit) | -int | -success | -Value of the Soft Limit imposed on the quota. | -||
- | state | -str | -success | -State of the user quota or tree quota record period. OK means No quota limits are exceeded. Soft_Exceeded means Soft limit is exceeded, and grace period is not expired. Soft_Exceeded_And_Expired means Soft limit is exceeded, and grace period is expired. Hard_Reached means Hard limit is reached. | -||
- | state_l10n | -str | -success | -Localized message string corresponding to state. | -||
- | tree_quota_for_user_quota | -complex | -success | -Additional Information of Tree Quota limits on which user quota exists. Only applicable for User Quotas. | -||
- | - | description | -str | -success | -Description of Tree Quota for user quota. | -|
- | - | hard_limit(cap_unit) | -int | -success | -Value of the Hard Limit imposed on the quota. | -|
- | - | path | -str | -success | -The path on which the quota will be imposed. | -|
- | tree_quota_id | -str | -success | -ID of the Tree Quota on which the specific User Quota exists. Only applicable for user quotas. | -||
- | uid | -int | -success | -The ID of the unix host for which user quota exists. Only applicable for user quotas. | -||
- | unix_name | -str | -success | -The Name of the unix host for which user quota exists. Only applicable for user quotas. | -||
- | windows_name | -str | -success | -The Name of the Windows host for which user quota exists. Only applicable for user quotas. | -||
- | windows_sid | -str | -success | -The SID of the windows host for which user quota exists. Only applicable for user quotas. | -
Parameter | -Type | -Required | -Default | -Choices | -Description | -|
---|---|---|---|---|---|---|
remote_support_id | -int | -True | -- | - | Unique identifier of the remote support configuration. |
- |
support_type | -str | -- | - |
|
- The type of remote support that is configured. Mandatory for modify and verify operation. SRS_Gateway support_type is only supported for verify operation. |
- |
remote_support_servers | - list elements: dict |
- - | - | - | One or two remote support servers. |
- |
- | address | -str | -True | -- | - | Gateway server IP address (IPv4). The address is a mandatory key. |
-
- | port | -int | -- | - | - | Gateway server port. |
-
- | is_primary | -bool | -- | - | - | Indicates whether the server is acting as the primary. One server must be set to false when two servers are configured. |
-
server_state | -str | -- | - |
|
- Indicates the state of the remote-support_servers. Required with remote_support_servers. |
- |
is_support_assist_license_accepted | -bool | -- | - | - | Indicates whether user has accepted remote support license agreement before enabling the Support Assist on the system for the first time. |
- |
is_cloudiq_enabled | -bool | -- | - | - | Indicates whether support for CloudIQ is enabled. |
- |
is_rsc_enabled | -bool | -- | - | - | Indicates whether support for Remote Service Credentials is enabled. |
- |
proxy_address | -str | -- | - | - | Proxy server IP address (IPv4). |
- |
proxy_port | -int | -- | - | - | Proxy server port number. |
- |
proxy_username | -str | -- | - | - | User name for proxy server access. |
- |
proxy_password | -str | -- | - | - | Password for proxy server access. |
- |
is_icw_configured | -bool | -- | - | - | Client already configured ICW. |
- |
verify_connection | -bool | -- | False | -- | Indicates whether to perform the verify call or not. |
- |
send_test_alert | -bool | -- | False | -- | Indicates whether to send a test alert or not. |
- |
wait_for_completion | -bool | -- | False | -- | Flag to indicate if the operation should be run synchronously or asynchronously. True signifies synchronous execution. By default, modify operation will run asynchronously. |
- |
return_support_license_text | -bool | -- | False | -- | Indicates whether to return support license agreement text or not. |
- |
state | -str | -True | -- |
|
- The state of the remote support configuration after the task is performed. For Delete operation only, it should be set to "absent". For get/modify operation it should be set to "present". |
- |
array_ip | -str | -True | -- | - | IP or FQDN of the PowerStore management system. |
- |
verifycert | -bool | -True | -- |
|
- Boolean variable to specify whether to validate SSL certificate or not. True - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS_CA_BUNDLE to the path of the SSL certificate. False - indicates that the SSL certificate should not be verified. |
- |
user | -str | -True | -- | - | The username of the PowerStore host. |
- |
password | -str | -True | -- | - | The password of the PowerStore host. |
- |
timeout | -int | -- | 120 | -- | Time after which the connection will get terminated. It is to be mentioned in seconds. |
- |
port | -int | -- | - | - | Port number for the PowerStore array. If not passed, it will take 443 as default. |
-
Key | -Type | -Returned | -Description | -||
---|---|---|---|---|---|
changed | -bool | -always | -Whether or not the resource has changed. | -||
job_details | -complex | -When asynchronous task is performed. | -The job details. | -||
- | id | -str | -success | -The ID of the job. | -|
remote_support_details | -complex | -When remote support configuration exists. | -Details of the remote support configuration. | -||
- | id | -int | -success | -Unique identifier of remote support configuration. | -|
- | is_cloudiq_enabled | -bool | -success | -Indicates whether support for CloudIQ is enabled. | -|
- | is_rsc_enabled | -bool | -success | -Indicates whether support for Remote Service Credentials is enabled. | -|
- | is_support_assist_license_accepted | -bool | -success | -Indicates whether user has accepted remote support license agreement before enabling the Support Assist on the system for the first time. | -|
- | proxy_address | -str | -success | -Proxy server IP address (IPv4). | -|
- | proxy_password | -str | -success | -Password for proxy server access. | -|
- | proxy_port | -int | -success | -Proxy server port number. | -|
- | proxy_username | -str | -success | -User name for proxy server access. | -|
- | remote_support_servers | -complex | -success | -['Details of two remote support servers.'] | -|
- | - | address | -str | -success | -Gateway server IP address (IPv4). | -
- | - | id | -str | -success | -Unique identifier of the remote support server. | -
- | - | is_primary | -bool | -success | -Indicates whether the server is acting as the primary. | -
- | - | port | -int | -success | -Gateway server port. | -
- | support_assist_license_agreement_text | -str | -success | -The support assist license agreement text. | -|
- | type | -str | -success | -The type of remote support that is configured. | -
Parameter | -Type | -Required | -Default | -Choices | -Description | -
---|---|---|---|---|---|
contact_id | -int | -True | -- | - | Unique identifier of the remote support contact. |
-
first_name | -str | -- | - | - | The first name of the support contact for this system. |
-
last_name | -str | -- | - | - | The last name of the support contact for this system. |
-
phone | -str | -- | - | - | The phone number of this support contact for this system. |
-
str | -- | - | - | The email address of the support contact for this system. |
- |
state | -str | -True | -- |
|
- The state of the remote support contact after the task is performed. For Delete operation only, it should be set to "absent". For get/modify operation it should be set to "present". |
-
array_ip | -str | -True | -- | - | IP or FQDN of the PowerStore management system. |
-
verifycert | -bool | -True | -- |
|
- Boolean variable to specify whether to validate SSL certificate or not. True - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS_CA_BUNDLE to the path of the SSL certificate. False - indicates that the SSL certificate should not be verified. |
-
user | -str | -True | -- | - | The username of the PowerStore host. |
-
password | -str | -True | -- | - | The password of the PowerStore host. |
-
timeout | -int | -- | 120 | -- | Time after which the connection will get terminated. It is to be mentioned in seconds. |
-
port | -int | -- | - | - | Port number for the PowerStore array. If not passed, it will take 443 as default. |
-
Key | -Type | -Returned | -Description | -|
---|---|---|---|---|
changed | -bool | -always | -Whether or not the resource has changed. | -|
remote_support_contact_details | -complex | -When remote support contact exists. | -Details of the remote support contact. | -|
- | str | -success | -The email address of the support contact for this system. | -|
- | first_name | -str | -success | -The first name of the support contact for this system. | -
- | id | -int | -success | -Unique identifier of remote support contact. | -
- | last_name | -str | -success | -The last name of the support contact for this system. | -
- | phone | -str | -success | -The phone number of this support contact for this system. | -
Parameter | -Type | -Required | -Default | -Choices | -Description | -
---|---|---|---|---|---|
remote_name | -str | -- | - | - | Name of the remote system. Parameter remote_name cannot be mentioned during addition of a new remote system. |
-
remote_id | -str | -- | - | - | ID of the remote system. ID for the remote system is autogenerated, cannot be passed during creation of a remote system. Parameter remote_id and remote_address are mutually exclusive. |
-
remote_user | -str | -- | - | - | Username used in basic authentication to remote PowerStore cluster. It can be mentioned only during creation of the remote system. |
-
remote_password | -str | -- | - | - | Password used in basic authentication to remote PowerStore cluster. It can be mentioned only during creation of the remote system. |
-
remote_address | -str | -- | - | - | Management IP of the remote system. Parameter remote_id and remote_address are mutually exclusive. |
-
new_remote_address | -str | -- | - | - | New management IP of the remote system. |
-
remote_port | -int | -- | 443 | -- | Remote system's port number. It can be mentioned only during creation of the remote system. |
-
description | -str | -- | - | - | Additional information about the remote system. To remove the description empty string is to be passed. |
-
network_latency | -str | -- | - |
|
- Replication traffic can be tuned for higher efficiency depending on the expected network latency. Setting to low will have latency of less than five milliseconds. Setting to high will have latency of more than five milliseconds. |
-
wait_for_completion | -bool | -- | False | -
|
- Flag to indicate if the operation should be run synchronously or asynchronously. True signifies synchronous execution. By default, modify and delete operation will run asynchronously. |
-
state | -str | -True | -- |
|
- The state of the remote system after the task is performed. For Delete operation only, it should be set to "absent". For all Create, Modify or Get details operations it should be set to "present". |
-
array_ip | -str | -True | -- | - | IP or FQDN of the PowerStore management system. |
-
verifycert | -bool | -True | -- |
|
- Boolean variable to specify whether to validate SSL certificate or not. True - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS_CA_BUNDLE to the path of the SSL certificate. False - indicates that the SSL certificate should not be verified. |
-
user | -str | -True | -- | - | The username of the PowerStore host. |
-
password | -str | -True | -- | - | The password of the PowerStore host. |
-
timeout | -int | -- | 120 | -- | Time after which the connection will get terminated. It is to be mentioned in seconds. |
-
port | -int | -- | - | - | Port number for the PowerStore array. If not passed, it will take 443 as default. |
-
Key | -Type | -Returned | -Description | -||
---|---|---|---|---|---|
changed | -bool | -always | -Whether or not the resource has changed. | -||
job_details | -complex | -When wait_for_completion is not set to True. | -Details of the job. | -||
- | id | -str | -success | -The id of the job. | -|
remote_system_details | -complex | -When remote system exists | -Details of the remote system. | -||
- | data_connection_state | -str | -success | -Data connection states of a remote system. | -|
- | data_connections | -complex | -success | -['List of data connections from each appliance in the local cluster to iSCSI target IP address.'] | -|
- | - | initiator_address | -str | -success | -Initiating address from the local node. | -
- | - | node_id | -str | -success | -Unique identifier of the local, initiating node. | -
- | - | status | -str | -success | -Possible transit connection statuses. | -
- | - | target_address | -str | -success | -Target address from the remote system. | -
- | data_network_latency | -str | -success | -['Network latency choices for a remote system. Replication traffic can be tuned for higher efficiency depending on the expected network latency.', 'This will only be used when the remote system type is PowerStore.'] | -|
- | description | -str | -success | -User-specified description of the remote system instance. | -|
- | discovery_chap_mode | -str | -success | -Challenge Handshake Authentication Protocol (CHAP) statu. | -|
- | id | -str | -success | -The system generated ID of the remote system. | -|
- | management_address | -str | -success | -The management cluster IP address of the remote system. | -|
- | name | -str | -success | -Name of the remote system. | -|
- | serial_number | -str | -success | -Serial number of the remote system instance. | -|
- | session_chap_mode | -str | -success | -Challenge Handshake Authentication Protocol (CHAP) status. | -|
- | state | -str | -success | -['Possible remote system states.', 'OK, Normal conditions.', 'Update_Needed, Verify and update needed to handle network configuration changes on the systems.', 'Management_Connection_Lost, Management connection to the remote peer is lost.'] | -|
- | type | -str | -success | -Remote system connection type between the local system. | -|
- | user_name | -str | -success | -Username used to access the non-PowerStore remote systems. | -|
- | version | -str | -success | -['Version of the remote system.', 'It was added in PowerStore version 2.0.0.0.'] | -
Parameter | -Type | -Required | -Default | -Choices | -Description | -
---|---|---|---|---|---|
replication_rule_name | -str | -- | - | - | Name of the replication rule. Required during creation of a replication rule. Parameter replication_rule_name and replication_rule_id are mutually exclusive. |
-
replication_rule_id | -str | -- | - | - | ID of the replication rule. ID for the rule is autogenerated, cannot be passed during creation of a replication rule. Parameter replication_rule_name and replication_rule_id are mutually exclusive. |
-
new_name | -str | -- | - | - | New name of the replication rule. Used for renaming a replication rule. |
-
rpo | -str | -- | - |
|
- Recovery point objective (RPO), which is the acceptable amount of data, measured in units of time, that may be lost in case of a failure. |
-
alert_threshold | -int | -- | - | - | Acceptable delay between the expected and actual replication sync intervals. The system generates an alert if the delay between the expected and actual sync exceeds this threshold. During creation, if not passed, then by default one RPO in minutes will be passed. The range of integers supported are in between 0 and 1440 (inclusive of both). |
-
remote_system | -str | -- | - | - | ID or name of the remote system to which this rule will replicate the associated resources. |
-
remote_system_address | -str | -- | - | - | The management IPv4 address of the remote system. It is required in case the remote system name passed in remote_system parameter is not unique on the PowerStore Array. If ID of the remote system is passed then no need to pass remote_system_address. |
-
state | -str | -True | -- |
|
- The state of the replication rule after the task is performed. For Delete operation only, it should be set to "absent". For all Create, Modify or Get details operations it should be set to "present". |
-
array_ip | -str | -True | -- | - | IP or FQDN of the PowerStore management system. |
-
verifycert | -bool | -True | -- |
|
- Boolean variable to specify whether to validate SSL certificate or not. True - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS_CA_BUNDLE to the path of the SSL certificate. False - indicates that the SSL certificate should not be verified. |
-
user | -str | -True | -- | - | The username of the PowerStore host. |
-
password | -str | -True | -- | - | The password of the PowerStore host. |
-
timeout | -int | -- | 120 | -- | Time after which the connection will get terminated. It is to be mentioned in seconds. |
-
port | -int | -- | - | - | Port number for the PowerStore array. If not passed, it will take 443 as default. |
-
Key | -Type | -Returned | -Description | -|
---|---|---|---|---|
changed | -bool | -always | -Whether or not the resource has changed. | -|
replication_rule_details | -complex | -When replication rule exists | -Details of the replication rule. | -|
- | alert_threshold | -int | -success | -Acceptable delay in minutes between the expected and actual replication sync intervals. | -
- | id | -str | -success | -The system generated ID of the replication rule. | -
- | name | -str | -success | -Name of the replication rule. | -
- | remote_system_id | -str | -success | -Unique identifier of the remote system to which this rule will replicate the associated resources. | -
- | remote_system_name | -str | -success | -Name of the remote system to which this rule will replicate the associated resources. | -
- | rpo | -str | -success | -Recovery point objective (RPO), which is the acceptable amount of data, measured in units of time, that may be lost in case of a failure. | -
Parameter | -Type | -Required | -Default | -Choices | -Description | -
---|---|---|---|---|---|
filesystem | -str | -- | - | - | Name/ID of the filesystem for which replication session exists. Parameter filesystem, nas_server, volume_group, volume, and session_id are mutually exclusive. |
-
nas_server | -str | -- | - | - | Name/ID of the NAS server for which replication session exists. Parameter filesystem, nas_server, volume_group, volume, and session_id are mutually exclusive. |
-
volume_group | -str | -- | - | - | Name/ID of the volume group for which a replication session exists. Parameter filesystem, nas_server, volume_group, volume, and session_id are mutually exclusive. |
-
volume | -str | -- | - | - | Name/ID of the volume for which replication session exists. Parameter filesystem, nas_server, volume_group, volume, and session_id are mutually exclusive. |
-
session_id | -str | -- | - | - | ID of the replication session. Parameter filesystem, nas_server, volume_group, volume, and session_id are mutually exclusive. |
-
session_state | -str | -- | - |
|
- State in which the replication session is present after performing the task. |
-
role | -str | -- | - |
|
- Role of the metro replication session. |
-
array_ip | -str | -True | -- | - | IP or FQDN of the PowerStore management system. |
-
verifycert | -bool | -True | -- |
|
- Boolean variable to specify whether to validate SSL certificate or not. True - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS_CA_BUNDLE to the path of the SSL certificate. False - indicates that the SSL certificate should not be verified. |
-
user | -str | -True | -- | - | The username of the PowerStore host. |
-
password | -str | -True | -- | - | The password of the PowerStore host. |
-
timeout | -int | -- | 120 | -- | Time after which the connection will get terminated. It is to be mentioned in seconds. |
-
port | -int | -- | - | - | Port number for the PowerStore array. If not passed, it will take 443 as default. |
-
Key | -Type | -Returned | -Description | -|
---|---|---|---|---|
changed | -bool | -always | -Whether or not the resource has changed. | -|
replication_session_details | -complex | -When replication session exists | -Details of the replication session. | -|
- | estimated_completion_timestamp | -str | -success | -Estimated completion time of the current replication operation. | -
- | id | -str | -success | -The system generated ID of the replication session. Unique across source and destination roles. | -
- | last_sync_timestamp | -str | -success | -Time of last successful synchronization. | -
- | local_resource_id | -str | -success | -Unique identifier of the local storage resource for the replication session. | -
- | name | -str | -success | -Name of the replication rule. | -
- | progress_percentage | -int | -success | -Progress of the current replication operation. | -
- | remote_resource_id | -str | -success | -Unique identifier of the remote storage resource for the replication session. | -
- | remote_system_id | -str | -success | -Unique identifier of the remote system instance. | -
- | replication_rule_id | -str | -success | -Associated replication rule instance if created by policy engine. | -
- | resource_type | -str | -success | -Storage resource type eligible for replication protection. volume - Replication session created on a volume. volume_group - Replication session created on a volume group. | -
- | role | -str | -success | -Role of the replication session. Source - The local resource is the source of the remote replication session. Destination - The local resource is the destination of the remote replication session. | -
- | state | -str | -success | -State of the replication session. | -
Parameter | -Type | -Required | -Default | -Choices | -Description | -
---|---|---|---|---|---|
role_name | -str | -- | - | - | Name of the role. |
-
role_id | -str | -- | - | - | Id of the role. |
-
state | -str | -True | -- |
|
- Define whether the role should exist or not. Value present, indicates that the role should exist on the system. Value absent, indicates that the role should not exist on the system. |
-
array_ip | -str | -True | -- | - | IP or FQDN of the PowerStore management system. |
-
verifycert | -bool | -True | -- |
|
- Boolean variable to specify whether to validate SSL certificate or not. True - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS_CA_BUNDLE to the path of the SSL certificate. False - indicates that the SSL certificate should not be verified. |
-
user | -str | -True | -- | - | The username of the PowerStore host. |
-
password | -str | -True | -- | - | The password of the PowerStore host. |
-
timeout | -int | -- | 120 | -- | Time after which the connection will get terminated. It is to be mentioned in seconds. |
-
port | -int | -- | - | - | Port number for the PowerStore array. If not passed, it will take 443 as default. |
-
Key | -Type | -Returned | -Description | -|
---|---|---|---|---|
changed | -bool | -always | -Whether or not the resource has changed. | -|
role_details | -complex | -When role exists. | -The role details. | -|
- | description | -str | -success | -Description of the role. | -
- | id | -str | -success | -The ID of the role. | -
- | is_built_in | -bool | -success | -Indicates whether the role is built-in. | -
- | name | -str | -success | -The name of the role. | -
Parameter | -Type | -Required | -Default | -Choices | -Description | -
---|---|---|---|---|---|
security_config_id | -int | -True | -- | - | ID of the security configuration. Mandatory for all operations. |
-
protocol_mode | -str | -- | - |
|
- Protocol mode of the security configuration. Mandatory only for modify operation. |
-
state | -str | -True | -- |
|
- Define whether the security config should exist or not. |
-
array_ip | -str | -True | -- | - | IP or FQDN of the PowerStore management system. |
-
verifycert | -bool | -True | -- |
|
- Boolean variable to specify whether to validate SSL certificate or not. True - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS_CA_BUNDLE to the path of the SSL certificate. False - indicates that the SSL certificate should not be verified. |
-
user | -str | -True | -- | - | The username of the PowerStore host. |
-
password | -str | -True | -- | - | The password of the PowerStore host. |
-
timeout | -int | -- | 120 | -- | Time after which the connection will get terminated. It is to be mentioned in seconds. |
-
port | -int | -- | - | - | Port number for the PowerStore array. If not passed, it will take 443 as default. |
-
Key | -Type | -Returned | -Description | -|
---|---|---|---|---|
changed | -bool | -always | -Whether or not the resource has changed. | -|
security_config_details | -complex | -When security config exists | -Details of the security configuration. | -|
- | id | -str | -success | -The system generated ID given to the security configuration. | -
- | idle_timeout | -int | -success | -Idle time (in seconds) after which login sessions will expire and require re-authentication. | -
- | protocol_mode | -str | -success | -The protocol mode of the security configuration. | -
Parameter | -Type | -Required | -Default | -Choices | -Description | -
---|---|---|---|---|---|
share_name | -str | -- | - | - | Name of the SMB share. Required during creation of the SMB share. For all other operations either share_name or share_id is required. |
-
share_id | -str | -- | - | - | ID of the SMB share. Should not be specified during creation. ID is auto generated. For all other operations either share_name or share_id is required. If share_id is used then no need to pass nas_server/filesystem/snapshot/ path. |
-
path | -str | -- | - | - | Local path to the file system/Snapshot or any existing sub-folder of the file system/Snapshot that is shared over the network. Path is relative to the base of the NAS server and must start with the name of the filesystem. Required for creation of the SMB share. |
-
filesystem | -str | -- | - | - | The ID/Name of the File System. Either filesystem or snapshot is required for creation of the SMB share. If filesystem name is specified, then nas_server is required to uniquely identify the filesystem. If filesystem parameter is provided, then snapshot cannot be specified. |
-
snapshot | -str | -- | - | - | The ID/Name of the Snapshot. Either filesystem or snapshot is required for creation of the SMB share. If snapshot name is specified, then nas_server is required to uniquely identify the snapshot. If snapshot parameter is provided, then filesystem cannot be specified. SMB share can be created only if access type of snapshot is "protocol". |
-
nas_server | -str | -- | - | - | The ID/Name of the NAS Server. It is not required if share_id is used. |
-
description | -str | -- | - | - | Description for the SMB share. Optional parameter when creating a share. To modify, pass the new value in description field. |
-
is_abe_enabled | -bool | -- | - | - | Indicates whether Access-based Enumeration (ABE) for SMB share is enabled. During creation, if not mentioned, then the default is False. |
-
is_branch_cache_enabled | -bool | -- | - | - | Indicates whether Branch Cache optimization for SMB share is enabled. During creation, if not mentioned then default is False. |
-
is_continuous_availability_enabled | -bool | -- | - | - | Indicates whether continuous availability for SMB 3.0 is enabled. During creation, if not mentioned, then the default is False. |
-
is_encryption_enabled | -bool | -- | - | - | Indicates whether encryption for SMB 3.0 is enabled at the shared folder level. During creation, if not mentioned then default is False. |
-
offline_availability | -str | -- | - |
|
- Defines valid states of Offline Availability. MANUAL- Only specified files will be available offline. DOCUMENTS- All files that users open will be available offline. PROGRAMS- Program will preferably run from the offline cache even when connected to the network. All files that users open will be available offline. NONE- Prevents clients from storing documents and programs in offline cache. |
-
umask | -str | -- | - | - | The default UNIX umask for new files created on the SMB Share. During creation, if not mentioned, then the default is "022". For all other operations, the default is None. |
-
state | -str | -True | -- |
|
- Define whether the SMB share should exist or not. Value present indicates that the share should exist on the system. Value absent indicates that the share should not exist on the system. |
-
array_ip | -str | -True | -- | - | IP or FQDN of the PowerStore management system. |
-
verifycert | -bool | -True | -- |
|
- Boolean variable to specify whether to validate SSL certificate or not. True - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS_CA_BUNDLE to the path of the SSL certificate. False - indicates that the SSL certificate should not be verified. |
-
user | -str | -True | -- | - | The username of the PowerStore host. |
-
password | -str | -True | -- | - | The password of the PowerStore host. |
-
timeout | -int | -- | 120 | -- | Time after which the connection will get terminated. It is to be mentioned in seconds. |
-
port | -int | -- | - | - | Port number for the PowerStore array. If not passed, it will take 443 as default. |
-
Key | -Type | -Returned | -Description | -||
---|---|---|---|---|---|
changed | -bool | -always | -Whether or not the resource has changed. | -||
smb_share_details | -complex | -When share exists. | -The SMB share details. | -||
- | description | -str | -success | -Additional information about the share. | -|
- | file_system | -complex | -success | -Includes ID and Name of filesystem and nas server for which smb share exists. | -|
- | - | filesystem_type | -str | -success | -Type of filesystem. | -
- | - | id | -str | -success | -ID of filesystem. | -
- | - | name | -str | -success | -Name of filesystem. | -
- | - | nas_server | -dict | -success | -nas_server of filesystem. | -
- | id | -str | -success | -The ID of the SMB share. | -|
- | is_ABE_enabled | -bool | -success | -Whether Access Based enumeration is enforced or not | -|
- | is_branch_cache_enabled | -bool | -success | -Whether branch cache is enabled or not. | -|
- | is_continuous_availability_enabled | -bool | -success | -Whether the share will be available continuously or not. | -|
- | is_encryption_enabled | -bool | -success | -Whether encryption is enabled or not. | -|
- | name | -str | -success | -Name of the SMB share. | -
Parameter | -Type | -Required | -Default | -Choices | -Description | -
---|---|---|---|---|---|
smtp_id | -int | -True | -- | - | Unique identifier of the SMTP configuration. |
-
smtp_address | -str | -- | - | - | IP address of the SMTP server. |
-
smtp_port | -int | -- | - | - | Port used for sending SMTP messages. |
-
source_email | -str | -- | - | - | Source email address used for sending SMTP messages. |
-
destination_email | -str | -- | - | - | Destination email address for the test. |
-
state | -str | -True | -- |
|
- The state of the SMTP configuration after the task is performed. For Delete operation only, it should be set to "absent". For all operations it should be set to "present". |
-
array_ip | -str | -True | -- | - | IP or FQDN of the PowerStore management system. |
-
verifycert | -bool | -True | -- |
|
- Boolean variable to specify whether to validate SSL certificate or not. True - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS_CA_BUNDLE to the path of the SSL certificate. False - indicates that the SSL certificate should not be verified. |
-
user | -str | -True | -- | - | The username of the PowerStore host. |
-
password | -str | -True | -- | - | The password of the PowerStore host. |
-
timeout | -int | -- | 120 | -- | Time after which the connection will get terminated. It is to be mentioned in seconds. |
-
port | -int | -- | - | - | Port number for the PowerStore array. If not passed, it will take 443 as default. |
-
Key | -Type | -Returned | -Description | -|
---|---|---|---|---|
changed | -bool | -always | -Whether or not the resource has changed. | -|
smtp_config_details | -complex | -When SMTP configuration exists. | -Details of the SMTP configuration. | -|
- | address | -str | -success | -IP address of the SMTP server. | -
- | id | -int | -success | -Unique identifier of SMTP configuration. | -
- | port | -int | -success | -Port used for sending SMTP messages. | -
- | source_email | -str | -success | -Source email address used for sending SMTP messages. | -
Parameter | -Type | -Required | -Default | -Choices | -Description | -
---|---|---|---|---|---|
snapshot_name | -str | -- | - | - | The name of the Snapshot. Either snapshot name or ID is required. |
-
snapshot_id | -str | -- | - | - | The ID of the Snapshot. Either snapshot ID or Snapshot name is required. |
-
volume | -str | -- | - | - | The volume. This could be the volume name or ID. |
-
volume_group | -str | -- | - | - | The volume group. This could be the volume group name or ID. |
-
new_snapshot_name | -str | -- | - | - | The new name of the Snapshot. |
-
desired_retention | -str | -- | - | - | The retention value for the Snapshot. If the retention value is not specified, the Snapshot details would be returned. To create a Snapshot, either a retention or expiration timestamp must be given. If the Snapshot does not have any retention value - specify it as 'None'. |
-
retention_unit | -str | -- | - |
|
- The unit for retention. If this unit is not specified, 'hours' is taken as default retention_unit. If desired_retention is specified, expiration_timestamp cannot be specified. |
-
expiration_timestamp | -str | -- | - | - | The expiration timestamp of the Snapshot. This should be provided in UTC format, e.g 2019-07-24T10:54:54Z. |
-
description | -str | -- | - | - | The description for the Snapshot. |
-
state | -str | -True | -- |
|
- Defines whether the Snapshot should exist or not. |
-
array_ip | -str | -True | -- | - | IP or FQDN of the PowerStore management system. |
-
verifycert | -bool | -True | -- |
|
- Boolean variable to specify whether to validate SSL certificate or not. True - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS_CA_BUNDLE to the path of the SSL certificate. False - indicates that the SSL certificate should not be verified. |
-
user | -str | -True | -- | - | The username of the PowerStore host. |
-
password | -str | -True | -- | - | The password of the PowerStore host. |
-
timeout | -int | -- | 120 | -- | Time after which the connection will get terminated. It is to be mentioned in seconds. |
-
port | -int | -- | - | - | Port number for the PowerStore array. If not passed, it will take 443 as default. |
-
Key | -Type | -Returned | -Description | -|||
---|---|---|---|---|---|---|
changed | -bool | -always | -Whether or not the resource has changed. | -|||
create_vg_snap | -bool | -When value exists | -A boolean flag to indicate whether volume group snapshot got created. | -|||
create_vol_snap | -bool | -When value exists | -A boolean flag to indicate whether volume snapshot got created. | -|||
delete_vg_snap | -bool | -When value exists | -A boolean flag to indicate whether volume group snapshot got deleted. | -|||
delete_vol_snap | -bool | -When value exists | -A boolean flag to indicate whether volume snapshot got deleted. | -|||
modify_vg_snap | -bool | -When value exists | -A boolean flag to indicate whether volume group snapshot got modified. | -|||
modify_vol_snap | -bool | -When value exists | -A boolean flag to indicate whether volume snapshot got modified. | -|||
snap_details | -complex | -When snapshot exists | -Details of the snapshot. | -|||
- | creation_timestamp | -str | -success | -The creation timestamp of the snapshot. | -||
- | description | -str | -success | -Description about the snapshot. | -||
- | id | -str | -success | -The system generated ID given to the snapshot. | -||
- | name | -str | -success | -Name of the snapshot. | -||
- | performance_policy_id | -str | -success | -The performance policy for the snapshot. | -||
- | protection_data | -complex | -success | -The protection data of the snapshot. | -||
- | - | expiration_timestamp | -str | -success | -The expiration timestamp of the snapshot. | -|
- | protection_policy_id | -str | -success | -The protection policy of the snapshot. | -||
- | size | -int | -success | -Size of the snapshot. | -||
- | state | -str | -success | -The state of the snapshot. | -||
- | type | -str | -success | -The type of the snapshot. | -||
- | volumes | -complex | -success | -The volumes details of the volume group snapshot. | -||
- | - | id | -str | -success | -The system generated ID given to the volume associated with the volume group. | -
Parameter | -Type | -Required | -Default | -Choices | -Description | -
---|---|---|---|---|---|
name | -str | -- | - | - | String variable. Indicates the name of the Snapshot rule. |
-
snapshotrule_id | -str | -- | - | - | String variable. Indicates the ID of the Snapshot rule. |
-
new_name | -str | -- | - | - | String variable. Indicates the new name of the Snapshot rule. Used for renaming operation. |
-
days_of_week | - list elements: str |
- - | - |
|
- List of strings to specify days of the week on which the Snapshot rule should be applied. Must be applied for Snapshot rules where the 'time_of_day' parameter is set. Optional for the Snapshot rule created with an interval. When 'days_of_week' is not specified for a new Snapshot rule, the rule is applied on every day of the week. |
-
interval | -str | -- | - |
|
- String variable. Indicates the interval between Snapshots. When creating a Snapshot rule, specify either "interval" or "time_of_day", but not both. |
-
desired_retention | -int | -- | - | - | Integer variable. Indicates the desired Snapshot retention period. It is required when creating a new Snapshot rule. |
-
time_of_day | -str | -- | - | - | String variable. Indicates the time of the day to take a daily Snapshot, with the format "hh:mm" in 24 hour time format. When creating a Snapshot rule, specify either "interval"or "time_of_day" but not both. |
-
delete_snaps | -bool | -- | False | -- | Boolean variable to specify whether all Snapshots previously created by this rule should also be deleted when this rule is removed. True specifies to delete all previously created Snapshots by this rule while deleting this rule. False specifies to retain all previously created Snapshots while deleting this rule. |
-
state | -str | -True | -- |
|
- String variable indicates the state of Snapshot rule. For "Delete" operation only, it should be set to "absent". For all Create, Modify or Get details operation it should be set to "present". |
-
array_ip | -str | -True | -- | - | IP or FQDN of the PowerStore management system. |
-
verifycert | -bool | -True | -- |
|
- Boolean variable to specify whether to validate SSL certificate or not. True - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS_CA_BUNDLE to the path of the SSL certificate. False - indicates that the SSL certificate should not be verified. |
-
user | -str | -True | -- | - | The username of the PowerStore host. |
-
password | -str | -True | -- | - | The password of the PowerStore host. |
-
timeout | -int | -- | 120 | -- | Time after which the connection will get terminated. It is to be mentioned in seconds. |
-
port | -int | -- | - | - | Port number for the PowerStore array. If not passed, it will take 443 as default. |
-
Key | -Type | -Returned | -Description | -||
---|---|---|---|---|---|
changed | -bool | -always | -Whether or not the resource has changed. | -||
snapshotrule_details | -complex | -When snapshot rule exists | -Details of the snapshot rule. | -||
- | days_of_week | -list | -success | -List of string to specify days of the week on which the rule should be applied. | -|
- | desired_retention | -int | -success | -Desired snapshot retention period. | -|
- | id | -str | -success | -The system generated ID given to the snapshot rule. | -|
- | interval | -str | -success | -The interval between snapshots. | -|
- | name | -str | -success | -Name of the snapshot rule. | -|
- | policies | -complex | -success | -The protection policies details of the snapshot rule. | -|
- | - | id | -str | -success | -The protection policy ID in which the snapshot rule is selected. | -
- | - | name | -str | -success | -Name of the protection policy in which the snapshot rule is selected. | -
- | time_of_day | -str | -success | -The time of the day to take a daily snapshot. | -
Parameter | -Type | -Required | -Default | -Choices | -Description | -|
---|---|---|---|---|---|---|
vol_name | -str | -- | - | - | Unique name of the volume. This value must contain 128 or fewer printable unicode characters. Required when creating a volume. All other functionalities on a volume are supported using volume name or ID. |
- |
vg_name | -str | -- | - | - | The name of the volume group. A volume can optionally be assigned to a volume group at the time of creation. Use the Volume Group Module for modification of the assignment. |
- |
vol_id | -str | -- | - | - | The 36 character long ID of the volume, automatically generated when a volume is created. Cannot be used while creating a volume. All other functionalities on a volume are supported using volume name or ID. |
- |
size | -float | -- | - | - | Size of the volume. Minimum volume size is 1MB. Maximum volume size is 256TB. Size must be a multiple of 8192. Required in case of create and expand volume. |
- |
cap_unit | -str | -- | - |
|
- Volume size unit. Used to signify unit of the size provided for creation and expansion of volume. It defaults to 'GB', if not specified. |
- |
new_name | -str | -- | - | - | The new volume name for the volume, used in case of rename functionality. |
- |
description | -str | -- | - | - | Description for the volume. Optional parameter when creating a volume. To modify, pass the new value in description field. |
- |
protection_policy | -str | -- | - | - | The protection_policy of the volume. To represent policy, both name or ID can be used interchangably. The module will detect both. A volume can be assigned a protection policy at the time of creation of volume or later as well. The policy can also be changed for a given volume by simply passing the new value. The policy can be removed by passing an empty string. Check examples for more clarity. |
- |
performance_policy | -str | -- | - |
|
- The performance_policy for the volume. A volume can be assigned a performance policy at the time of creation of the volume, or later as well. The policy can also be changed for a given volume, by simply passing the new value. Check examples for more clarity. If not given, performance policy will be 'medium'. |
- |
host | -str | -- | - | - | Host to be mapped/unmapped to a volume. If not specified, an unmapped volume is created. Only one of the host or host group can be supplied in one call. To represent host, both name or ID can be used interchangeably. The module will detect both. |
- |
hostgroup | -str | -- | - | - | Hostgroup to be mapped/unmapped to a volume. If not specified, an unmapped volume is created. Only one of the host or host group can be mapped in one call. To represent a hostgroup, both name or ID can be used interchangeably. The module will detect both. |
- |
mapping_state | -str | -- | - |
|
- Define whether the volume should be mapped to a host or hostgroup. Value mapped - indicates that the volume should be mapped to the host or host group. Value unmapped - indicates that the volume should not be mapped to the host or host group. Only one of a host or host group can be supplied in one call. |
- |
hlu | -int | -- | - | - | Logical unit number for the host/host group volume access. Optional parameter when mapping a volume to host/host group. HLU modification is not supported. |
- |
clone_volume | -dict | -- | - | - | Details of the volume clone. |
- |
- | name | -str | -- | - | - | Name of the clone set to be created. |
-
- | description | -str | -- | - | - | Description of the clone. |
-
- | host | -str | -- | - | - | Unique identifier or name of the host to be attached to the clone. |
-
- | host_group | -str | -- | - | - | Unique identifier or name of the host group to be attached to the clone. |
-
- | logical_unit_number | -int | -- | - | - | logical unit number when creating a mapped volume. If no host_id or host_group_id is specified, logical_unit_number is ignored. |
-
- | protection_policy | -str | -- | - | - | The protection policy of the clone set to be created. |
-
- | performance_policy | -str | -- | - |
|
- The performance policy of the clone set to be created. |
-
source_volume | -str | -- | - | - | Unique identifier or name of the volume to refresh from. |
- |
source_snap | -str | -- | - | - | Unique identifier or name of the source snapshot that will be used for the restore operation. |
- |
create_backup_snap | -bool | -- | - | - | Indicates whether a backup snapshot of the target volume will be created or not. |
- |
backup_snap_profile | -dict | -- | - | - | Details of the backup snapshot set to be created. |
- |
- | name | -str | -- | - | - | Name of the backup snapshot set to be created. The default name of the volume snapshot is the date and time when the snapshot is taken. |
-
- | description | -str | -- | - | - | Description of the backup snapshot set. |
-
- | performance_policy | -str | -- | - |
|
- Performance policy assigned to the snapshot. |
-
- | expiration_timestamp | -str | -- | - | - | Time after which the snapshot set can be auto-purged. |
-
state | -str | -True | -- |
|
- Define whether the volume should exist or not. Value present - indicates that the volume should exist on the system. Value absent - indicates that the volume should not exist on the system. |
- |
remote_system | -str | -- | - | - | The remote system to which metro relationship will be established. The remote system must support metro volume. This is mandatory while configuring a metro volume. To represent remote system, both name and ID are interchangeable. This parameter is added in PowerStore version 3.0.0.0. |
- |
remote_appliance_id | -str | -- | - | - | A remote system appliance ID to which volume will be assigned. This parameter is added in PowerStore version 3.0.0.0. |
- |
end_metro_config | -bool | -- | False | -- | Whether to end the metro session from a volume. This is mandatory for end metro configuration operation. |
- |
delete_remote_volume | -bool | -- | - | - | Whether to delete the remote volume during removal of metro session. This is parameter is added in the PowerStore version 3.0.0.0. |
- |
array_ip | -str | -True | -- | - | IP or FQDN of the PowerStore management system. |
- |
verifycert | -bool | -True | -- |
|
- Boolean variable to specify whether to validate SSL certificate or not. True - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS_CA_BUNDLE to the path of the SSL certificate. False - indicates that the SSL certificate should not be verified. |
- |
user | -str | -True | -- | - | The username of the PowerStore host. |
- |
password | -str | -True | -- | - | The password of the PowerStore host. |
- |
timeout | -int | -- | 120 | -- | Time after which the connection will get terminated. It is to be mentioned in seconds. |
- |
port | -int | -- | - | - | Port number for the PowerStore array. If not passed, it will take 443 as default. |
-
Key | -Type | -Returned | -Description | -|||||||
---|---|---|---|---|---|---|---|---|---|---|
changed | -bool | -always | -Whether or not the resource has changed. | -|||||||
is_volume_cloned | -bool | -always | -Whether or not the clone of volume is created. | -|||||||
is_volume_refreshed | -bool | -always | -Whether or not the volume is refreshed. | -|||||||
is_volume_restored | -bool | -always | -Whether or not the volume is restored. | -|||||||
volume_details | -complex | -When volume exists | -Details of the volume. | -|||||||
- | description | -str | -success | -description about the volume. | -||||||
- | hlu_details | -complex | -success | -HLU details for mapped host/host group. | -||||||
- | - | host_group_id | -str | -success | -The host group ID mapped to the volume. | -|||||
- | - | host_id | -str | -success | -The host ID mapped to the volume. | -|||||
- | - | id | -str | -success | -The HLU ID. | -|||||
- | - | logical_unit_number | -int | -success | -Logical unit number for the host/host group volume access. | -|||||
- | host | -complex | -success | -Hosts details mapped to the volume. | -||||||
- | - | id | -str | -success | -The host ID mapped to the volume. | -|||||
- | - | name | -str | -success | -Name of the Host mapped to the volume. | -|||||
- | host_group | -complex | -success | -Host groups details mapped to the volume. | -||||||
- | - | id | -str | -success | -The host group ID mapped to the volume. | -|||||
- | - | name | -str | -success | -Name of the Host group mapped to the volume. | -|||||
- | id | -str | -success | -The system generated ID given to the volume. | -||||||
- | mapped_volumes | -complex | -success | -This is the inverse of the resource type host_volume_mapping association. | -||||||
- | - | id | -str | -success | -Unique identifier of a mapping between a host and a volume. | -|||||
- | - | logical_unit_number | -int | -success | -Logical unit number for the host volume access. | -|||||
- | metro_replication_session_id | -str | -success | -The ID of the metro replication session assigned to volume. | -||||||
- | name | -str | -success | -Name of the volume. | -||||||
- | nguid | -int | -success | -NVMe Namespace globally unique identifier. Used for volumes attached to NVMEoF hosts. | -||||||
- | node_affinity | -str | -success | -This attribute shows which node will be advertised as the optimized IO path to the volume. | -||||||
- | nsid | -int | -success | -NVMe Namespace unique identifier in the NVME subsystem. Used for volumes attached to NVMEoF hosts. | -||||||
- | performance_policy_id | -str | -success | -The performance policy for the volume. | -||||||
- | protection_policy_id | -str | -success | -The protection policy of the volume. | -||||||
- | size | -int | -success | -Size of the volume. | -||||||
- | snapshots | -complex | -success | -List of snapshot associated with the volume. | -||||||
- | - | id | -str | -success | -The system generated ID given to the snapshot. | -|||||
- | - | name | -str | -success | -Name of the snapshot. | -|||||
- | volume_groups | -complex | -success | -The volume group details of the volume. | -||||||
- | - | id | -str | -success | -The system generated ID given to the volume group. | -|||||
- | - | name | -str | -success | -Name of the volume group. | -|||||
- | wwn | -str | -success | -The world wide name of the volume. | -
Parameter | -Type | -Required | -Default | -Choices | -Description | -|
---|---|---|---|---|---|---|
vg_name | -str | -- | - | - | The name of the volume group. |
- |
vg_id | -str | -- | - | - | The id of the volume group. It can be used only for Modify, Add/Remove, or Delete operation. |
- |
volumes | - list elements: str |
- - | - | - | This is a list of volumes. Either the volume ID or name must be provided for adding/removing existing volumes from a volume group. If volumes are given, then vol_state should also be specified. |
- |
vol_state | -str | -- | - |
|
- String variable. Describes the state of volumes inside a volume group. If volume is given, then vol_state should also be specified. |
- |
new_vg_name | -str | -- | - | - | The new name of the volume group. |
- |
description | -str | -- | - | - | Description about the volume group. |
- |
protection_policy | -str | -- | - | - | String variable. Represents Protection policy id or name used for volume group. Specifying an empty string or "" removes the existing protection policy from volume group. |
- |
is_write_order_consistent | -bool | -- | - | - | A boolean flag to indicate whether Snapshot sets of the volume group will be write-order consistent. If this parameter is not specified, the array by default sets it to true. |
- |
source_vg | -str | -- | - | - | ID or name of the volume group to refresh from. |
- |
source_snap | -str | -- | - | - | ID or name of the snapshot to restore from. |
- |
create_backup_snap | -bool | -- | - | - | Specifies whether a backup snapshot set of the target volume group needs to be created before attempting refresh or restore. If not specified it will be set to True. |
- |
backup_snap_profile | -dict | -- | - | - | Snapshot volume group request. |
- |
- | name | -str | -- | - | - | Name of snapshot set to be created. |
-
- | description | -str | -- | - | - | Description of the snapshot set. |
-
- | expiration_timestamp | -str | -- | - | - | Time after which the snapshot set can be auto-purged. |
-
vg_clone | -dict | -- | - | - | Parameters to support clone of a volume group. |
- |
- | name | -str | -True | -- | - | Name for the clone volume group. |
-
- | description | -str | -- | - | - | Description for the clone volume group. |
-
- | protection_policy | -str | -- | - | - | ID or name of the protection policy to assign to the clone volume. |
-
state | -str | -True | -- |
|
- Define whether the volume group should exist or not. |
- |
array_ip | -str | -True | -- | - | IP or FQDN of the PowerStore management system. |
- |
verifycert | -bool | -True | -- |
|
- Boolean variable to specify whether to validate SSL certificate or not. True - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS_CA_BUNDLE to the path of the SSL certificate. False - indicates that the SSL certificate should not be verified. |
- |
user | -str | -True | -- | - | The username of the PowerStore host. |
- |
password | -str | -True | -- | - | The password of the PowerStore host. |
- |
timeout | -int | -- | 120 | -- | Time after which the connection will get terminated. It is to be mentioned in seconds. |
- |
port | -int | -- | - | - | Port number for the PowerStore array. If not passed, it will take 443 as default. |
-
Key | -Type | -Returned | -Description | -|||
---|---|---|---|---|---|---|
add_vols_to_vg | -bool | -When value exists | -A boolean flag to indicate whether volume/s got added to volume group. | -|||
changed | -bool | -always | -Whether or not the resource has changed. | -|||
create_vg | -bool | -When value exists | -A boolean flag to indicate whether volume group got created. | -|||
delete_vg | -bool | -When value exists | -A boolean flag to indicate whether volume group got deleted. | -|||
modify_vg | -bool | -When value exists | -A boolean flag to indicate whether volume group got modified. | -|||
remove_vols_from_vg | -bool | -When value exists | -A boolean flag to indicate whether volume/s got removed from volume group. | -|||
volume_group_details | -complex | -When volume group exists | -Details of the volume group. | -|||
- | description | -str | -success | -description about the volume group. | -||
- | id | -str | -success | -The system generated ID given to the volume group. | -||
- | is_write_order_consistent | -bool | -success | -A boolean flag to indicate whether snapshot sets of the volume group will be write-order consistent. | -||
- | name | -str | -success | -Name of the volume group. | -||
- | protection_policy_id | -str | -success | -The protection policy of the volume group. | -||
- | snapshots | -complex | -success | -The snapshots associated with the volume group. | -||
- | - | id | -str | -success | -ID of the snapshot. | -|
- | - | name | -str | -success | -Name of the snapshot. | -|
- | type | -str | -success | -The type of the volume group. | -||
- | volumes | -complex | -success | -The volumes details of the volume group. | -||
- | - | id | -str | -success | -The system generated ID given to the volume associated with the volume group. | -|
- | - | name | -str | -success | -The name of the volume associated with the volume group. | -