Dell EMC PowerStore CLI Reference Guide © 2021 Dell Inc. or its subsidiaries. All rights reserved. Dell, EMC, and other trademarks are trademarks of Dell Inc. or its subsidiaries. Other trademarks may be trademarks of their respective owners. June 2021 Rev.
Table of Contents Compute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 discovered_initiator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 show . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
refresh . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60 import_host_volume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60 show . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
discover . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122 import_vnx_consistency_group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123 show . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124 import_vnx_volume . . . . .
[Added in 2.0.0.0] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211 [Added in 2.0.0.0] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212 create delete [Added in 2.0.0.0] set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
dns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269 show . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270 set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
[Added in 2.0.0.0] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 310 [Added in 2.0.0.0] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 312 create delete set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
exchange . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 354 reset_certificates [Added in 2.0.0.0] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 355 Storage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
create . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 405 delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 405 set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 473 update_user_mappings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 474 nas_server/download . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 474 group . . . . . . . . . . . . .
show . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 514 create . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 517 delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 519 set .
show . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 577 [Added in 2.0.0.0] set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 577 service_config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
show . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 679 Compute Manage host configurations, virtual machines and VMware integration discovered_initiator Use this resource type to list initiators currently connected to the cluster that are not associated with a host. An initiator currently connected to the cluster, but not associated with any host.
Attribute Select protocol_type_l10n X Sort Search Format discovered_initiator show [ -select ,… ] [ -output { nvp | csv [ -table ] [ -noformat ] | table | json [ -raw ] } ] Action qualifiers -select Display selected attributes in the output. -output Change the output format. nvp Display output as plain text. csv Display output in CSV format. table Display output in a table. json Display output in JSON format. host Use this resource type to manage hosts that access the cluster.
type [Added in 2.0.0.0] Type: enumerated value ("External", "Internal") Was added in version 2.0.0.0. os_type Type: enumerated value ("AIX", "ESXi", "HP-UX", "Linux", "Solaris", "Windows") Operating system of the host. host_group_id Type: string Associated host group, if host is part of host group. host_initiators Type: array of objects Filtering on the fields of this embedded resource is not supported. See host_initiators for more details type_l10n [Added in 2.0.0.
port_name IQN name aka address for iSCSI or WWN name for FC (SCSI) or NQN name for all NVMe-oF port types. port_type Protocol type of the host initiator. iSCSI An iSCSI host initiator. FC A Fibre Channel host initiator. NVMe A NVMe host initiator. Single type for all NVMe Fabrics types (NVMe/FC, NVMe/TCP, NVMe/RoCEv2). Values was added in 2.0.0.0: NVMe. chap_single_username Username for CHAP authentication. This value must be 1 to 64 UTF-8 characters.
veth_id Unique identifier of the virtual Ethernet port the initiator is logged into. Null if one of the following is non-null: bond, eth_port_id or fc_port_id. eth_port_id Unique identifier of the Ethernet port the initiator is logged into. Null if one of the following is non-null: bond_id, veth_id or fc_port_id. show Property capabilities Attribute Select Sort Search description X X X host_group.description X host_group.id X host_group.
Attribute Select Sort Search import_host_system.agent_type X import_host_system.agent_type_l10n X import_host_system.agent_version X import_host_system.id X import_host_system.last_update_time X import_host_system.os_type X import_host_system.os_type_l10n X import_host_system.os_version X import_host_system.user_name X mapped_hosts.host_group_id X mapped_hosts.host_id X mapped_hosts.id X mapped_hosts.logical_unit_number X mapped_hosts.
Action qualifiers -id Unique identifier of the host. -name Unique name of the existing object (host). -select Display selected attributes in the output. -sort Sorts output field+ (or just field) sort by field in ascending order. field- sort by field in descending order. -offset Start record list starting from specific value. -limit Limits the number of listed records. -all Query all records. -query Query records that fulfill the specified condition. -output Change the output format.
Format host create -name -os_type { Windows | Linux | ESXi | AIX | HP-UX | Solaris } ( -initiators -port_name -port_type { iSCSI | FC | NVMe[Added in 2.0.0.0] } [ -chap_single_username ] [ { -chap_single_password | -chap_single_passwordSecure } ] [ -chap_mutual_username ] [ { -chap_mutual_password | -chap_mutual_passwordSecure } ] )… [ -description ] [ -async ] Action qualifiers -name The host name.
-chap_mutual_password Password for CHAP authentication. This value must be 12 to 64 UTF-8 characters. This password is not queriable. CHAP password is required when the cluster CHAP mode is mutual authentication. -chap_mutual_passwordSecure Secure version of -chap_mutual_password. Value will be queried interactively. -description An optional description for the host. The description should not be more than 256 UTF-8 characters long and should not have any unprintable characters.
-id Unique identifier of the host. -name Unique name of the existing object (host). -name The host name. The name should not be more than 128 UTF-8 characters long and should not have any unprintable characters. -description An optional description for the host. The description should not be more than 256 UTF-8 characters long and should not have any unprintable characters. -remove_initiators The list of initiator port_names to be removed.
username is required when the cluster CHAP mode is mutual authentication. -chap_mutual_password Password for CHAP authentication. This value must be 12 to 64 UTF-8 characters. This password is not queriable. CHAP password is required when the cluster CHAP mode is mutual authentication. -chap_mutual_passwordSecure Secure version of -chap_mutual_password. Value will be queried interactively. -modify_initiators Parameters for updating initiator in host.
Action qualifiers -id Unique identifier of the host. -name Unique name of the existing object (host). -volume_id Volume to attach. -logical_unit_number Logical unit number for the volume, if desired. -async Perform asynchronous operation. detach Detach host from volume. Format host { -id | -name } detach -volume_id [ -async ] Action qualifiers -id Unique identifier of the host. -name Unique name of the existing object (host). -volume_id Volume to detach.
id Type: string The host group unique identifier. name Type: string The host group name. This property supports case-insensitive filtering. description Type: string A description for the host group. hosts This is the inverse of the resource type host association. See host for more details mapped_host_groups This is the inverse of the resource type host_volume_mapping association.
Attribute Select hosts.id X hosts.name X hosts.os_type X hosts.os_type_l10n X hosts.type X hosts.type_l10n X id X mapped_host_groups.host_group_id X mapped_host_groups.host_id X mapped_host_groups.id X mapped_host_groups.logical_unit_number X mapped_host_groups.
field+ (or just field) sort by field in ascending order. field- sort by field in descending order. -offset Start record list starting from specific value. -limit Limits the number of listed records. -all Query all records. -query Query records that fulfill the specified condition. -output Change the output format. nvp Display output as plain text. csv Display output in CSV format. table Display output in a table. json Display output in JSON format. create Create a host group.
delete Delete a host group. Delete fails if host group is attached to a volume. Format host_group { -id | -name } delete [ -async ] Action qualifiers -id Unique identifier of the host group. -name Unique name of the existing object (host_group). -async Perform asynchronous operation. set Modify a host group. Modify does not support rename and add/modify at the same time.
-async Perform asynchronous operation. attach Attach host group to volume. Format host_group { -id | -name } attach -volume_id [ -logical_unit_number <0..16383> ] [ -async ] Action qualifiers -id Unique identifier of the host group. -name Unique name of the existing object (host_group). -volume_id Volume to attach. -logical_unit_number Logical unit number for the volume, if desired. -async Perform asynchronous operation. detach Detach host group from volume.
host_virtual_volume_mapping Virtual volume mapping details. Virtual volume mapping details. This resource type has queriable associations from host, host_group, virtual_volume Attributes id Type: string Unique identifier of a mapping between a host and a virtual volume. host_id Type: string Unique identifier of a host attached to a virtual volume. The host_id and host_group_id cannot both be set. host_group_id Type: string Unique identifier of a host group attached to a virtual volume.
Attribute Select Sort Search host.host_initiators X host.id X host.name X host.os_type X host.os_type_l10n X host.type X host.type_l10n X host_group.description X host_group.id X host_group.name X host_group_id X X X host_id X X X id X X X virtual_volume.appliance_id X virtual_volume.creation_timestamp X virtual_volume.creator_type X virtual_volume.creator_type_l10n X virtual_volume.family_id X virtual_volume.id X virtual_volume.io_priority X virtual_volume.
Attribute Select virtual_volume.is_readonly X virtual_volume.location_history X virtual_volume.migration_session_id X virtual_volume.name X virtual_volume.parent_id X virtual_volume.profile_id X virtual_volume.size X virtual_volume.source_id X virtual_volume.source_timestamp X virtual_volume.storage_container_id X virtual_volume.type X virtual_volume.type_l10n X virtual_volume.usage_type X virtual_volume.usage_type_l10n X virtual_volume.
-sort Sorts output field+ (or just field) sort by field in ascending order. field- sort by field in descending order. -offset Start record list starting from specific value. -limit Limits the number of listed records. -all Query all records. -query Query records that fulfill the specified condition. -output Change the output format. nvp Display output as plain text. csv Display output in CSV format. table Display output in a table. json Display output in JSON format.
be set. host_group_id Type: string Unique identifier of a host group attached to a volume. The host_id and host_group_id cannot both be set. volume_id Type: string Unique identifier of the volume to which the host is attached. logical_unit_number Type: 32-bit signed integer (0 to 2147483647) Logical unit number for the host volume access. host This is the embeddable reference form of host_id attribute. See host for more details host_group This is the embeddable reference form of host_group_id attribute.
Attribute Select Sort Search host.type X host.type_l10n X host_group.description X host_group.id X host_group.name X host_group_id X X X host_id X X X id X X X logical_unit_number X X X volume.appliance_id X volume.creation_timestamp X volume.description X volume.id X volume.is_replication_destination X volume.location_history X volume.migration_session_id X volume.name X volume.nguid X volume.node_affinity X volume.node_affinity_l10n X volume.
Attribute Select volume.performance_policy_id X volume.protection_data X volume.protection_policy_id X volume.size X volume.state X volume.state_l10n X volume.type X volume.type_l10n X volume.
-limit Limits the number of listed records. -all Query all records. -query Query records that fulfill the specified condition. -output Change the output format. nvp Display output as plain text. csv Display output in CSV format. table Display output in a table. json Display output in JSON format. vcenter Use this resource type to manage vCenter instances.
username Type: string User name to login to vCenter. vendor_provider_status [Added in 2.0.0.0] Type: enumerated value ("Not_Registered", "Offline", "Online") General status of the VASA vendor provider in vCenter. A VASA vendor provider is required for HCI deployments, and optional for SAN deployments. To register or re-register the VASA vendor provider, pass appropriate storage system credentials using the modify request. Was added in version 2.0.0.0. vendor_provider_status_l10n [Added in 2.0.0.
Attribute Select virtual_machines.id X virtual_machines.instance_uuid X virtual_machines.is_consistent X virtual_machines.is_consistent_snaps_supported X virtual_machines.memory_mb X virtual_machines.name X virtual_machines.protection_data X virtual_machines.protection_policy_id X virtual_machines.status X virtual_machines.status_l10n X virtual_machines.type X virtual_machines.type_l10n X virtual_machines.vcenter_id X virtual_machines.
field+ (or just field) sort by field in ascending order. field- sort by field in descending order. -offset Start record list starting from specific value. -limit Limits the number of listed records. -all Query all records. -query Query records that fulfill the specified condition. -output Change the output format. nvp Display output as plain text. csv Display output in CSV format. table Display output in a table. json Display output in JSON format. create Add a vCenter.
-passwordSecure Secure version of -password. Value will be queried interactively. [Added in 2.0.0.0] -vasa_provider_credentials Was added in version 2.0.0.0. -username Username of the local user account which will be used by vSphere to register VASA provider. -password Password of the local user account which will be used by vSphere to register VASA provider. -passwordSecure Secure version of -password. Value will be queried interactively. -async Perform asynchronous operation.
-id Unique identifier of the vCenter to modify. -address IP address of vCenter host, in IPv4, IPv6, or hostname format. Must be a new address of the same vCenter. -username User name to login to vCenter. Password needs to be provided to modify the user name. -password Password to login to vCenter. -passwordSecure Secure version of -password. Value will be queried interactively. [Added in 2.0.0.0] -vasa_provider_credentials Was added in version 2.0.0.0.
vcenter_instance_uuid [Deprecated in 2.0.0.0] Type: string UUID instance of the vCenter that hosts the VM. Was deprecated in version 2.0.0.0. name Type: string User-assigned name of the VM in vCenter. This property supports case-insensitive filtering. description Type: string Description of the VM in vCenter. type Type: enumerated value ("Primary", "Snapshot", "Template") Type of VM: Primary A base VM. Template A VM template. Snapshot A snapshot of a VM.
Yellow VM is operating normally, but there are potential issues. Red VM is experiencing issues and is not operating normally. Grey Status of the VM cannot be determined. protection_policy_id Type: string Unique identifier of the protection policy assigned to the VM. Not applicable to template and snapshot VMs. is_consistent Type: boolean Indicates whether the VM snapshot is crash-consistent.
parent This is the embeddable reference form of parent_id attribute. See virtual_machine for more details children This is the inverse of the resource type virtual_machine association. See virtual_machine for more details vcenter This is the embeddable reference form of vcenter_id attribute. See vcenter for more details virtual_volumes [Added in 2.0.0.0] List of the virtual_volumes that are associated with this virtual_machine.
Attribute Select Sort Search children.cpu_count X children.description X children.guest_os X children.id X children.instance_uuid X children.is_consistent X children.is_consistent_snaps_supported X children.memory_mb X children.name X children.protection_data X children.protection_policy_id X children.status X children.status_l10n X children.type X children.type_l10n X children.vcenter_id X children.
Attribute Select Sort Search instance_uuid X X X is_consistent X X X is_consistent_snaps_supported X X X memory_mb X X X name X X X parent.cpu_count X parent.description X parent.guest_os X parent.id X parent.instance_uuid X parent.is_consistent X parent.is_consistent_snaps_supported X parent.memory_mb X parent.name X parent.protection_data X parent.protection_policy_id X parent.status X parent.status_l10n X parent.type X parent.type_l10n X parent.
Attribute Select Sort Search parent.vcenter_instance_uuid X protection_data X X X protection_policy.description X protection_policy.id X protection_policy.is_replica X protection_policy.name X protection_policy.type X protection_policy.type_l10n X protection_policy_id X X X status X X X status_l10n X X X type X X X type_l10n X X X vcenter.address X vcenter.id X vcenter.instance_uuid X vcenter.username X vcenter.vendor_provider_status X vcenter.
Attribute Select virtual_volumes.appliance_id X virtual_volumes.creation_timestamp X virtual_volumes.creator_type X virtual_volumes.creator_type_l10n X virtual_volumes.family_id X virtual_volumes.id X virtual_volumes.io_priority X virtual_volumes.io_priority_l10n X virtual_volumes.is_readonly X virtual_volumes.location_history X virtual_volumes.migration_session_id X virtual_volumes.name X virtual_volumes.parent_id X virtual_volumes.profile_id X virtual_volumes.
Attribute Select virtual_volumes.usage_type_l10n X virtual_volumes.virtual_machine_uuid X Sort Search Format virtual_machine [ { -id | -name } ] show [ -select ,… ] [ -sort [+|-],… ] [ -offset ] [ { -limit | -all } ] [ -query ] [ -output { nvp | csv [ -table ] [ -noformat ] | table | json [ -raw ] } ] Action qualifiers -id Unique identifier of the virtual machine to query. -name Unique name of the existing object (virtual_machine).
csv Display output in CSV format. table Display output in a table. json Display output in JSON format. delete Delete a virtual machine snapshot. This operation cannot be used on a base virtual machine or virtual machine template. Format virtual_machine { -id | -name } delete [ -async ] Action qualifiers -id Unique identifier of the virtual machine snapshot to delete. -name Unique name of the existing object (virtual_machine). -async Perform asynchronous operation.
snapshot Create a snapshot of a virtual machine. This operation cannot be used on a virtual machine snapshot or template. Format virtual_machine { -id | -name } snapshot [ -name ] [ -description ] [ -async ] Action qualifiers -id Unique identifier of the virtual machine to create a snapshot of. -name Unique name of the existing object (virtual_machine). -name Name of the snapshot. This value must contain 80 or fewer printable Unicode characters.
protocol Type: enumerated value ("FC", "FCoE", "Other", "Unknown", "iSCSI") Protocol type of the import host initiator. Valid values are: Other Protocol type is other. iSCSI Protocol type is internet SCSI. FC Protocol type is Fibre Channel. FCoE Protocol type is Fibre Channel over Ethernet. Unknown Protocol type is unknown to PowerStore. import_host_system_id Type: string Unique identifier of the import host system. protocol_l10n Type: string Localized message string corresponding to protocol.
-id Unique identifier of the import host initiator to query. -select Display selected attributes in the output. -sort Sorts output field+ (or just field) sort by field in ascending order. field- sort by field in descending order. -offset Start record list starting from specific value. -limit Limits the number of listed records. -all Query all records. -query Query records that fulfill the specified condition. -output Change the output format. nvp Display output as plain text.
has queriable association from host Attributes id Type: string Unique identifier of the import host system. agent_address Type: string Hostname or IPv4 address of the import host system. agent_type Type: enumerated value ("EQL", "Native_MPIO", "Power_Path", "Unknown") Type of import host system. Valid values are: EQL EQL MPIO. Native_MPIO Native MPIO. Power_Path POWER PATH MPIO. Unknown Type of host agent is unknown to PowerStore.
Linux Linux. ESXi ESXi. Unknown Operating system of the host system is unknown to PowerStore. os_version Type: string Operating system version of the import host system. agent_status Type: enumerated value ("Conflict_Detected", "Running", "Unknown", "Version_Unsupported") Status of the import host system. Valid values are: Unknown Agent status is unknown. Running Agent is up and running.
agent_status_l10n Type: string Localized message string corresponding to agent_status. hosts This is the inverse of the resource type host association. See host for more details show Property capabilities Attribute Select Sort Search agent_address X X X agent_api_version X X X agent_port X X X agent_status X X X agent_status_l10n X X X agent_type X X X agent_type_l10n X X X agent_version X X X hosts.description X hosts.host_group_id X hosts.
Attribute Select Sort Search hosts.type_l10n X id X X X last_update_time X X X os_type X X X os_type_l10n X X X os_version X X X user_name X X X Format import_host_system [ -id ] show [ -select ,… ] [ -sort [+|-],… ] [ -offset ] [ { -limit | -all } ] [ -query ] [ -output { nvp | csv [ -table ] [ -noformat ] | table | json [ -raw ] } ] Action qualifiers -id Unique identifier of the import host system to query.
-output Change the output format. nvp Display output as plain text. csv Display output in CSV format. table Display output in a table. json Display output in JSON format. create Add an import host system so that it can be mapped to a volume. Before mapping an import host system, ensure that a host agent is installed. Host agents can be installed on Linux, Windows, and ESXi host systems only. While adding import_host_system if Host is not present a new Host shall be created.
-user_name Username for the import host system. -password Password for the specified username. -passwordSecure Secure version of -password. Value will be queried interactively. -chap_single_username Username for single CHAP authentication. This username is required when the cluster is using single authentication CHAP mode. -chap_single_password Password for single CHAP authentication. This password is required when the cluster is using single authentication CHAP mode.
-async Perform asynchronous operation. refresh Refresh the details of a specific import host system. Use this operation when there is a change to the import host or import host volumes. Format import_host_system -id refresh [ -async ] Action qualifiers -id Unique identifier of the import host system for which to refresh details. -async Perform asynchronous operation. import_host_volume Use these resource types to manage import host volumes.
array_identifier Type: string Unique identifier of the storage system. size Type: size (0 to 9223372036854775807 (8192.00P)) Size of the import host volume, in bytes. status Type: enumerated value ("Offline", "Online", "Unknown") Status of the import host volume. is_migrating Type: boolean Indicates whether the import host volume is migrating. active_path Type: enumerated value ("Destination", "None", "Source") Active path of the host volume.
Cancel_Forced Aborted the ongoing cancel operation. None Migration state is not known to PowerStore. naa_id Type: string Unique identifier of a volume that is presented to the import host. last_update_time Type: date time Time when the import host volume was last updated. array_type_l10n Type: string Localized message string corresponding to array_type. status_l10n Type: string Localized message string corresponding to status.
Attribute Select Sort Search array_identifier X X X array_type X X X array_type_l10n X X X host_system_id X X X id X X X import_state X X X import_state_l10n X X X is_migrating X X X last_update_time X X X mount_paths X X X naa_id X X X name X X X protocols X X X protocols_l10n X X X size X X X status X X X status_l10n X X X Format import_host_volume [ { -id | -name } ] show [ -select ,… ] [ -sort [+|-
-name Unique name of the existing object (import_host_volume). -select Display selected attributes in the output. -sort Sorts output field+ (or just field) sort by field in ascending order. field- sort by field in descending order. -offset Start record list starting from specific value. -limit Limits the number of listed records. -all Query all records. -query Query records that fulfill the specified condition. -output Change the output format. nvp Display output as plain text.
Unique identifier of the PS Group. name Type: string Name of the PS Group. This property supports case-insensitive filtering. serial_number Type: string Serial number of the PS Group. management_address Type: string Management address of the PS Group. This can be an IPv4 address, IPv6 address, or FQDN (Fully Qualified Domain Name). description Type: string Description of the PS Group. user_name Type: string Name used to log in to the PS Group.
import_psgroup_volumes This is the inverse of the resource type import_psgroup_volume association. See import_psgroup_volume for more details show Property capabilities Attribute Select Sort Search description X X X group_address X X X id X X X import_psgroup_volumes.block_size X import_psgroup_volumes.block_size_l10n X import_psgroup_volumes.host_volume_ids X import_psgroup_volumes.id X import_psgroup_volumes.import_psgroup_id X import_psgroup_volumes.
Attribute Select Sort Search management_address X X X name X X X serial_number X X X supported_import_type X X X supported_import_type_l10n X X X user_name X X X Format import_psgroup [ { -id | -name } ] show [ -select ,… ] [ -sort [+|-],… ] [ -offset ] [ { -limit | -all } ] [ -query ] [ -output { nvp | csv [ -table ] [ -noformat ] | table | json [ -raw ] } ] Action qualifiers -id Unique identifier of the PS Group.
-query Query records that fulfill the specified condition. -output Change the output format. nvp Display output as plain text. csv Display output in CSV format. table Display output in a table. json Display output in JSON format. discover Discover the importable volumes and snapshot schedules in the PS Group. Format import_psgroup { -id | -name } discover [ -async ] Action qualifiers -id Unique identifier of the PS Group. -name Unique name of the existing object (import_psgroup).
Indicates whether the volume is online. import_psgroup_id Type: string Unique identifier of the PS Group with which the volume is associated. name Type: string Name of the volume. This property supports case-insensitive filtering. size Type: size (0 to 9223372036854775807 (8192.00P)) Size of the volume, in bytes. block_size Type: enumerated value ("4K_Bytes", "512_Bytes", "Unknown") Block size of the volume. Valid values are: 512_Bytes 512 byte block size. 4K_Bytes 4096 byte block size.
Prepared Volume is prepared for migration. Disabled_For_IO Volume is disabled for IO from host. In_Progress Volume migration is in progress. Completed Volume is migrated. Aborted Volume migration is aborted Unknown Volume migration state is unknown to PowerStore.
for more details show Property capabilities Attribute Select Sort Search block_size X X X block_size_l10n X X X host_volume_ids X X X id X X X import_psgroup.description X import_psgroup.group_address X import_psgroup.id X import_psgroup.last_update_time X import_psgroup.management_address X import_psgroup.name X import_psgroup.serial_number X import_psgroup.supported_import_type X import_psgroup.supported_import_type_l10n X import_psgroup.
Attribute Select Sort Search migration_state X X X migration_state_l10n X X X name X X X size X X X wwn X X X Format import_psgroup_volume [ { -id | -name } ] show [ -select ,… ] [ -sort [+|-],… ] [ -offset ] [ { -limit | -all } ] [ -query ] [ -output { nvp | csv [ -table ] [ -noformat ] | table | json [ -raw ] } ] Action qualifiers -id Unique identifier of the PS Group volume.
-output Change the output format. nvp Display output as plain text. csv Display output in CSV format. table Display output in a table. json Display output in JSON format. import_snapshot_schedules Return the snapshot schedules for a PS Group volume. Format import_psgroup_volume { -id | -name } import_snapshot_schedules [ -async ] Action qualifiers -id Unique identifier of the PS Group volume. -name Unique name of the existing object (import_psgroup_volume).
Was added in version 1.0.2. name Type: string User-specified name of the import session. This property supports case-insensitive filtering. description Type: string User-specified description of the import session. remote_system_id Type: string Unique identifier of the storage system that contains the source volume or consistency group to be imported. source_resource_id Type: string Unique identifier of the volume or consistency group to be imported.
Import session states Scheduled Indicates that a user scheduled the import to run at a later time. The import remains in this state and waits until the schedule expires. Paused Indicates that the data copy between the source and destination volumes is paused. Queued Indicates that all imports are queued and run in a First In First Out (FIFO) order. This occurs when there are more active import sessions than supported. In_Progress Indicates that a queued import session is now in progress.
Import_Completed Indicates that all operations completed successfully for a given import after a commit. In this state, the source volume is no longer mapped to the host and all stale paths are cleaned up. Cancelled Indicates that a user forcefully cancelled the import. Failed Indicates that there was an error during import. The appropriate error message is returned in the error_response object.
Cancel_Required Indicates that agentless import has failed during copy operation and once in this state user is expected to cancel the import. Values was added in 1.0.2: Cancel_Required. estimated_completion_timestamp Type: date time When the import is in the Copy_In_Progress state, this value indicates the estimated time at which the data copy will complete. Before the import is in the Copy_In_Progress state, the value is null.
scheduled_timestamp Type: date time Date and time at which the import session is scheduled to run. The date is specified in ISO 8601 format with the time expressed in UTC format. error Type: object Filtering on the fields of this embedded resource is not supported. See error for more details last_update_timestamp Type: date time Date and time when was the import was last updated. This value is updated each time the import job updates. type_l10n [Added in 1.0.
show Property capabilities Attribute Select Sort Search automatic_cutover X X X average_transfer_rate X X X current_transfer_rate X X X description X X X destination_resource_id X X X destination_resource_type X X X destination_resource_type_l10n X X X error X X X estimated_completion_timestamp X X X id X X X last_update_timestamp X X X name X X X parent_session_id X X X progress_percentage X X X protection_policy_id X X X remote_system.
Attribute Select Sort Search remote_system.description X remote_system.discovery_chap_mode X remote_system.discovery_chap_mode_l10n X remote_system.id X remote_system.iscsi_addresses X remote_system.management_address X remote_system.name X remote_system.serial_number X remote_system.session_chap_mode X remote_system.session_chap_mode_l10n X remote_system.state X remote_system.state_l10n X remote_system.type X remote_system.type_l10n X remote_system.
Attribute Select Sort Search type X X X type_l10n X X X volume_group_id X X X Format import_session [ { -id | -name } ] show [ -select ,… ] [ -sort [+|-],… ] [ -offset ] [ { -limit | -all } ] [ -query ] [ -output { nvp | csv [ -table ] [ -noformat ] | table | json [ -raw ] } ] Action qualifiers -id Unique identifier of the import session -name Unique name of the existing object (import_session).
nvp Display output as plain text. csv Display output in CSV format. table Display output in a table. json Display output in JSON format. create Create a new import session. The source storage system and hosts that access the volumes or consistency groups must be added prior to creating an import session. The volumes or consistency groups must be in a migration-ready state.
-type [Added in 1.0.2] Was added in version 1.0.2. [Added in 1.0.2] -host_ids Hosts to be mapped to the destination resource for an agentless import session. Was added in version 1.0.2. -host_group_ids [Added in 2.0.0.0] Unique identifiers of the host groups that map to the destination resource for an agentless import session.
-scheduled_timestamp Date and time at which the import session is scheduled to start. The date time is specified in ISO 8601 format with the time expressed in UTC format. -async Perform asynchronous operation. delete Delete an import session that is in a Completed, Failed, or Cancelled state. Delete removes the historical record of the import. To stop active import sessions, use the Cancel operation. You can delete the import session after cancelling it.
cancel Cancel an active import session. Cancel is allowed when the import is in a Scheduled, Queued, Copy_In_Progress, or Ready_For_Cutover state. After a successful cancellation, the host is mapped to original source volume, all paths are cleaned up, and the import state is Cancelled. The import can be attempted again in the future. In most cases, the Cancel operation gracefully rolls back the import based on the source and host error responses.
-async Perform asynchronous operation. cutover Commit an import session that is in a Ready_For_Cutover state. When the import session is created with the automatic_cutover attribute set to false, you must use the Cutover operation to complete the import. Until the cutover is complete, PowerStore forwards IO to the source volume to keep it in sync with all host IOs. You can cancel the import during this state if you want to continue using the source volume.
pause Pauses an ongoing import session. When this occurs, the background data copy stops, but IO to the source still occurs. Pause is only supported when the import job is in a in Copy_In_Progress state. You can resume or cancel the paused import. Format import_session { -id | -name } pause [ -async ] Action qualifiers -id Unique identifier of the import session -name Unique name of the existing object (import_session). -async Perform asynchronous operation.
Format import_session { -id | -name } start_copy [ -async ] Action qualifiers -id Unique identifier of the import session. -name Unique name of the existing object (import_session). -async Perform asynchronous operation. import_storage_center Use these resource types to discover the Storage Center (SC) volumes and consistency groups that can be imported to PowerStore.
Serial number of the SC array. api_version Type: string API version of the SC OS (SCOS). status Type: enumerated value ("Degraded", "Down", "Unknown", "Up") Status of an SC array. Valid values are: Up Volume state is up. Down Volume state is down. Degraded Volume is in degraded state. Unknown Volume migration state is unknown to PowerStore. last_update_time Type: date time Timestamp at which the SC array details were last updated.
import_storage_center_consistency_groups This is the inverse of the resource type import_storage_center_consistency_group association. See import_storage_center_consistency_group for more details show Property capabilities Attribute Select Sort Search api_version X X X id X X X import_storage_center_consistency_groups.id X import_storage_center_consistency_groups.import_storage_cent er_id import_storage_center_consistency_groups.importable_criteria import_storage_center_consistency_groups.
Attribute Select Sort Search import_storage_center_volumes.is_active X import_storage_center_volumes.is_read_only X import_storage_center_volumes.migration_state X import_storage_center_volumes.migration_state_l10n X import_storage_center_volumes.name X import_storage_center_volumes.size X import_storage_center_volumes.
-name Unique name of the existing object (import_storage_center). -select Display selected attributes in the output. -sort Sorts output field+ (or just field) sort by field in ascending order. field- sort by field in descending order. -offset Start record list starting from specific value. -limit Limits the number of listed records. -all Query all records. -query Query records that fulfill the specified condition. -output Change the output format. nvp Display output as plain text.
-id Unique identifier of the SC array. -name Unique name of the existing object (import_storage_center). -async Perform asynchronous operation. import_storage_center_consistency_group Use these resource types to discover the Storage Center (SC) volumes and consistency groups that can be imported to PowerStore. This resource type has queriable associations from import_storage_center_volume, import_storage_center Attributes id Type: string Unique identifier of the SC consistency group.
import_storage_center This is the embeddable reference form of import_storage_center_id attribute. See import_storage_center for more details show Property capabilities Attribute Select Sort Search id X X X import_storage_center.api_version X import_storage_center.id X import_storage_center.last_update_time X import_storage_center.management_address X import_storage_center.model X import_storage_center.name X import_storage_center.serial_number X import_storage_center.
Attribute import_storage_center_volumes.import_storage_center_consiste ncy_group_id import_storage_center_volumes.import_storage_center_consiste ncy_group_names Select Sort Search X X import_storage_center_volumes.import_storage_center_id X import_storage_center_volumes.importable_criteria X import_storage_center_volumes.importable_criteria_l10n X import_storage_center_volumes.is_active X import_storage_center_volumes.is_read_only X import_storage_center_volumes.
-select Display selected attributes in the output. -sort Sorts output field+ (or just field) sort by field in ascending order. field- sort by field in descending order. -offset Start record list starting from specific value. -limit Limits the number of listed records. -all Query all records. -query Query records that fulfill the specified condition. -output Change the output format. nvp Display output as plain text. csv Display output in CSV format. table Display output in a table.
-name Unique name of the existing object (import_storage_center_consistency_group). -async Perform asynchronous operation. import_storage_center_volume Use these resource types to discover the Storage Center (SC) volumes that can be imported to PowerStore. This resource type has queriable associations from import_storage_center, import_storage_center_consistency_group Attributes id Type: string Unique identifier of the SC volume. name Type: string Name of the SC volume.
is_active Type: boolean Indicates whether the SC volume is active on any controller. Only volumes that are active are importable. import_storage_center_id Type: string Unique identifier of the SC array where the volume resides. migration_state Type: enumerated value ("Aborted", "Disabled_For_IO", "Done", "In_Progress", "Legacy", "Not_Applicable", "Preparing", "Unknown") Migration status of a volume. Valid values are: Legacy Volume state is normal. Preparing Volume is prepared for migration.
"VNX_Internal_Volume", "VNX_Not_Ready", "XtremIO_State_Inappropriate", "XtremIO_Severity_Inappropriate", "XtremIO_Volume_Severity_Inappropriate", "XtremIO_Volume_State_Inappropriate") Volume import criteria. If the value is not Ready, the volume is not importable. host_volume_ids Type: array of strings List of host volume identifiers that correspond to SC volumes.
Attribute Select Sort Search health X X X health_l10n X X X host_volume_ids X X X id X X X import_storage_center.api_version X import_storage_center.id X import_storage_center.last_update_time X import_storage_center.management_address X import_storage_center.model X import_storage_center.name X import_storage_center.serial_number X import_storage_center.status X import_storage_center.status_l10n X import_storage_center.supported_import_type X import_storage_center.
Attribute Select Sort Search import_storage_center_consistency_group.
field+ (or just field) sort by field in ascending order. field- sort by field in descending order. -offset Start record list starting from specific value. -limit Limits the number of listed records. -all Query all records. -query Query records that fulfill the specified condition. -output Change the output format. nvp Display output as plain text. csv Display output in CSV format. table Display output in a table. json Display output in JSON format.
import_unity Use this resource type to discover the Unity system that is a source storage system for import This resource type has queriable associations from import_unity_volume, import_unity_consistency_group Attributes id Type: string Unique identifier of the Unity storage system that is a source storage system for import. This is the serial number of the storage system. name Type: string Name of the Unity storage system. This property supports case-insensitive filtering.
Ok_But The system is operating normally but there are potential issues. Degraded The system is working, but performance may not be optimum. Minor The system is working, but it has experienced one or more minor failures. Major The system is failing; some or all of its functions may be degraded or not working. This condition has a significant impact on the system and should be remedied immediately. Critical The system has failed and recovery may not be possible.
Localized message string corresponding to supported_import_type Was added in version 1.0.2. import_unity_volumes This is the inverse of the resource type import_unity_volume association. See import_unity_volume for more details import_unity_consistency_groups This is the inverse of the resource type import_unity_consistency_group association.
Attribute Select Sort Search import_unity_volumes.importable_criteria X import_unity_volumes.importable_criteria_l10n X import_unity_volumes.is_replication_destination X import_unity_volumes.is_thin_clone X import_unity_volumes.migration_state X import_unity_volumes.migration_state_l10n X import_unity_volumes.name X import_unity_volumes.size X import_unity_volumes.type X import_unity_volumes.type_l10n X import_unity_volumes.
field>[+|-],… ] [ -offset ] [ { -limit | -all } ] [ -query ] [ -output { nvp | csv [ -table ] [ -noformat ] | table | json [ -raw ] } ] Action qualifiers -id Unique identifier of the Unity storage system. -name Unique name of the existing object (import_unity). -select Display selected attributes in the output. -sort Sorts output field+ (or just field) sort by field in ascending order. field- sort by field in descending order.
Format import_unity { -id | -name } discover [ -async ] Action qualifiers -id Unique identifier of the Unity storage system. -name Unique name of the existing object (import_unity). -async Perform asynchronous operation. import_unity_consistency_group Use this resource type to discover the Unity consistency groups that can be imported to PowerStore.
import_unity_volume for more details import_unity This is the embeddable reference form of import_unity_id attribute. See import_unity for more details show Property capabilities Attribute Select Sort Search id X X X import_unity.api_version X import_unity.health X import_unity.health_l10n X import_unity.id X import_unity.last_updated_timestamp X import_unity.management_address X import_unity.model X import_unity.name X import_unity.serial_number X import_unity.
Attribute Select Sort Search import_unity_volumes.host_volume_ids X import_unity_volumes.id X import_unity_volumes.import_unity_consistency_group_id X import_unity_volumes.import_unity_id X import_unity_volumes.importable_criteria X import_unity_volumes.importable_criteria_l10n X import_unity_volumes.is_replication_destination X import_unity_volumes.is_thin_clone X import_unity_volumes.migration_state X import_unity_volumes.migration_state_l10n X import_unity_volumes.
-id Unique identifier of the Unity consistency group. -name Unique name of the existing object (import_unity_consistency_group). -select Display selected attributes in the output. -sort Sorts output field+ (or just field) sort by field in ascending order. field- sort by field in descending order. -offset Start record list starting from specific value. -limit Limits the number of listed records. -all Query all records. -query Query records that fulfill the specified condition.
Action qualifiers -id Unique identifier of the Unity consistency group. -name Unique name of the existing object (import_unity_consistency_group). -async Perform asynchronous operation. import_unity_volume Use this resource type to discover the Unity volumes that can be imported to PowerStore. This resource type has queriable associations from import_unity, import_unity_consistency_group Attributes id Type: string Unique identifier of the Unity volume.
health Type: enumerated value ("Critical", "Degraded", "Major", "Minor", "Non_Recoverable", "Ok", "Ok_But", "Unknown") Health status of the Unity storage system. Values are: Unknown The status of the system cannot be determined. Ok The system is operating normally. Ok_But The system is operating normally but there are potential issues. Degraded The system is working, but performance may not be optimum. Minor The system is working, but it has experienced one or more minor failures.
Migration state of the Unity volume. Values are: Normal The volume is not migrated. Prepared The volume is ready for migration. Disabled_For_IO Host I/O is disabled on the volume. In_Progress Volume migration is in progress. Completed The volume is migrated. Aborted Volume migration is cancelled. Not_Applicable Volume migration state is not applicable if the system only supports agentless import. Unknown The volume migration state is unknown to PowerStore.
List of host volume identifiers that correspond to Unity volumes. health_l10n Type: string Localized message string corresponding to health. type_l10n Type: string Localized message string corresponding to type. migration_state_l10n Type: string Localized message string corresponding to migration_state. importable_criteria_l10n Type: string Localized message string corresponding to importable_criteria. import_unity This is the embeddable reference form of import_unity_id attribute.
Attribute Select Sort Search import_unity.health_l10n X import_unity.id X import_unity.last_updated_timestamp X import_unity.management_address X import_unity.model X import_unity.name X import_unity.serial_number X import_unity.software_version X import_unity.supported_import_type X import_unity.supported_import_type_l10n X import_unity.user_name X import_unity_consistency_group.id X import_unity_consistency_group.import_unity_id X import_unity_consistency_group.
Attribute Select Sort Search is_thin_clone X X X migration_state X X X migration_state_l10n X X X name X X X size X X X type X X X type_l10n X X X wwn X X X Format import_unity_volume [ { -id | -name } ] show [ -select ,… ] [ -sort [+|-],… ] [ -offset ] [ { -limit | -all } ] [ -query ] [ -output { nvp | csv [ -table ] [ -noformat ] | table | json [ -raw ] } ] Action qualifiers -id Unique identifier of the Unity v
-all Query all records. -query Query records that fulfill the specified condition. -output Change the output format. nvp Display output as plain text. csv Display output in CSV format. table Display output in a table. json Display output in JSON format. import_snapshot_schedules Return the snapshot schedules associated with the specified Unity volume.
name Type: string Name of the VNX storage system. This property supports case-insensitive filtering. serial_number Type: string Serial number of the VNX storage system. management_address Type: string Management address for communicating with the VNX storage system. This is usually the address of Storage Processor A (SPA). The address can be an IPv4 address, IPv6 address, or FQDN (Fully Qualified Domain Name).
The software version of the block operating environment of the VNX storage system. [Added in 1.0.2] supported_import_type Type: enumerated value ("Agentless", "Non_Disruptive_And_Agentless", "Not_Supported") Was added in version 1.0.2. [Added in 1.0.2] supported_import_type_l10n Type: string Localized message string corresponding to supported_import_type Was added in version 1.0.2. import_vnx_volumes This is the inverse of the resource type import_vnx_volume association.
Attribute Select Sort Search import_vnx_volumes.id X import_vnx_volumes.import_vnx_array_id X import_vnx_volumes.import_vnx_consistency_group_id X import_vnx_volumes.importable_criteria X import_vnx_volumes.importable_criteria_l10n X import_vnx_volumes.migration_state X import_vnx_volumes.migration_state_l10n X import_vnx_volumes.name X import_vnx_volumes.size X import_vnx_volumes.
field>[+|-],… ] [ -offset ] [ { -limit | -all } ] [ -query ] [ -output { nvp | csv [ -table ] [ -noformat ] | table | json [ -raw ] } ] Action qualifiers -id Unique identifier of a VNX storage system. -name Unique name of the existing object (import_vnx_array). -select Display selected attributes in the output. -sort Sorts output field+ (or just field) sort by field in ascending order. field- sort by field in descending order.
Format import_vnx_array { -id | -name } discover [ -async ] Action qualifiers -id Unique identifier of the VNX storage system. -name Unique name of the existing object (import_vnx_array). -async Perform asynchronous operation. import_vnx_consistency_group Use this resource type to show the VNX consistency groups that can be imported to PowerStore.
In_Progress Import is in progress. Members_Not_Ready The member or members of teh consistency group are not ready for import. No_Members There are no members in the consistency group. Max_Members The maximum number of members for a consistency group has been exceeded. Not_In_Sync The array must be refreshed. Imported Import is complete. Incompatible_Firmware The software version on the source array is not compatible.
Attribute Select import_vnx_array.is_faulted X import_vnx_array.last_updated_timestamp X import_vnx_array.management_address X import_vnx_array.model X import_vnx_array.name X import_vnx_array.serial_number X import_vnx_array.software_version X import_vnx_array.supported_import_type X import_vnx_array.supported_import_type_l10n X import_vnx_array.user_name X import_vnx_array_id X import_vnx_volumes.health X import_vnx_volumes.health_l10n X import_vnx_volumes.
Attribute Select Sort Search import_vnx_volumes.name X import_vnx_volumes.size X import_vnx_volumes.
-query Query records that fulfill the specified condition. -output Change the output format. nvp Display output as plain text. csv Display output in CSV format. table Display output in a table. json Display output in JSON format. import_vnx_volume Use this resource type to show the VNX volumes and that can be imported to PowerStore. This resource type has queriable associations from import_vnx_array, import_vnx_consistency_group Attributes id Type: string Unique identifier of the VNX volume.
refreshed using the refresh action to import the volume. Values are: * Invalid - The volume is in an invalid state. * Ready - The volume is ready. This is the healthy state of a storage pool based volume. * Faulted - The volume is faulted. * Offline - The volume is offline. * Destroying - The volume is being destroyed. * Default - The volume is ready. This is the healthy state of a RAID group based volume.
Host_Not_Added The host or hosts accessing the volume have not been added to the appliance. Imported Import is complete. Incompatible_Firmware The software version on the source array is not compatible. Incompatible_Host_Agent The agent version on the host is not compatible. Undetermined The import status cannot be determined due to an internal error. Contact technical support. Host_Volume_Offline The host volume is offline.
VNX_Not_Ready The VNX volume is not in a ready state. VNX_Internal_Volume The VNX volume is an internal volume. Unity_System_Health_Inappropriate The health of the Unity system is not suitable for import. Unity_Volume_Health_Inappropriate The health of the Unity volume is not suitable for import. XtremIO_Severity_Inappropriate The severity level of the XtremIO system is not suitable for import. XtremIO_State_Inappropriate The state of the XtremIO system is not suitable for import.
import_vnx_array This is the embeddable reference form of import_vnx_array_id attribute. See import_vnx_array for more details import_vnx_consistency_group This is the embeddable reference form of import_vnx_consistency_group_id attribute. See import_vnx_consistency_group for more details show Property capabilities Attribute Select Sort Search health X X X health_l10n X X X host_volume_ids X X X id X X X import_vnx_array.alternate_management_address X import_vnx_array.
Attribute Select Sort Search import_vnx_array_id X X X import_vnx_consistency_group.id X import_vnx_consistency_group.import_vnx_array_id X import_vnx_consistency_group.importable_criteria X import_vnx_consistency_group.importable_criteria_l10n X import_vnx_consistency_group.
-sort Sorts output field+ (or just field) sort by field in ascending order. field- sort by field in descending order. -offset Start record list starting from specific value. -limit Limits the number of listed records. -all Query all records. -query Query records that fulfill the specified condition. -output Change the output format. nvp Display output as plain text. csv Display output in CSV format. table Display output in a table. json Display output in JSON format.
Name of the XtremIO storage system. This property supports case-insensitive filtering. management_address Type: string Management address to use for communicating with the XtremIO storage system. The address can be an IPv4 address, IPv6 address, or FQDN (Fully Qualified Domain Name). serial_number Type: string Serial number of the XtremIO storage system. cluster_guid Type: string Cluster GUID of the XtremIO storage system. [Added in 1.0.
Not_Supported The source array does not support import. Was added in version 1.0.2. [Added in 1.0.2] state Type: enumerated value ("Active", "Attempting_To_Start", "Configured", "Down", "Failed", "Initializing", "Start", "Starting", "Stop_Failed", "Stopped", "Stopping", "Unknown") State of XtremIO storage system. Active XtremIO system is in active state. Start XtremIO system is in start state. Configured XtremIO system is configured but not yet active. Initializing XtremIO system is initializing.
Information The highest severity for this entity and all contained/members is Information. Minor The highest severity for this entity and all contained/members is Minor. Major The highest severity for this entity and all contained/members is Major. Critical - The highest severity for this The severity is unknown to PowerStore entity and all contained/members is Was added in version 1.0.2. Critical.
import_xtremio_volume for more details [Added in 1.0.2] import_xtremio_consistency_groups This is the inverse of the resource type import_xtremio_consistency_group association. See import_xtremio_consistency_group for more details show Property capabilities Attribute Select Sort Search cluster_guid X X X id X X X import_xtremio_consistency_groups.id X import_xtremio_consistency_groups.import_xtremio_id X import_xtremio_consistency_groups.
Attribute Select Sort Search import_xtremio_volumes.is_replication_destination X import_xtremio_volumes.name X import_xtremio_volumes.severity X import_xtremio_volumes.severity_l10n X import_xtremio_volumes.size X import_xtremio_volumes.
Format import_xtremio [ { -id | -name } ] show [ -select ,… ] [ -sort [+|-],… ] [ -offset ] [ { -limit | -all } ] [ -query ] [ -output { nvp | csv [ -table ] [ -noformat ] | table | json [ -raw ] } ] Action qualifiers -id Unique identifier of the XtremIO storage system. -name Unique name of the existing object (import_xtremio). -select Display selected attributes in the output.
discover [Added in 1.0.2] Discover the importable volumes and consistency groups in the XtremIO storage system. Was added in version 1.0.2. Format import_xtremio { -id | -name } discover [ -async ] Action qualifiers -id Unique identifier of the XtremIO storage system. -name Unique name of the existing object (import_xtremio). -async Perform asynchronous operation.
importable_criteria_l10n [Added in 1.0.2] Type: string Localized message string corresponding to importable_criteria Was added in version 1.0.2. [Added in 1.0.2] import_xtremio_volumes This is the inverse of the resource type import_xtremio_volume association. See import_xtremio_volume for more details import_xtremio [Added in 1.0.2] This is the embeddable reference form of import_xtremio_id attribute.
Attribute Select import_xtremio.supported_import_type X import_xtremio.supported_import_type_l10n X import_xtremio.user_name X import_xtremio.xms_version X import_xtremio_id X import_xtremio_volumes.certainty X import_xtremio_volumes.certainty_l10n X import_xtremio_volumes.id X Sort Search X X X X import_xtremio_volumes.import_xtremio_consistency_group_id X import_xtremio_volumes.import_xtremio_consistency_group_n ames X import_xtremio_volumes.
Attribute Select Sort Search importable_criteria_l10n X X X name X X X Format import_xtremio_consistency_group [ { -id | -name } ] show [ -select ,… ] [ -sort [+|-],… ] [ -offset ] [ { -limit | -all } ] [ -query ] [ -output { nvp | csv [ -table ] [ -noformat ] | table | json [ -raw ] } ] Action qualifiers -id Unique identifier of the XtremIO consistency group. -name Unique name of the existing object (import_xtremio_consistency_group).
csv Display output in CSV format. table Display output in a table. json Display output in JSON format. import_snapshot_schedules [Added in 1.0.2] Return the snapshot schedules associated with the specified XtremIO consistency group. Was added in version 1.0.2. Format import_xtremio_consistency_group { -id | -name } import_snapshot_schedules [ -async ] Action qualifiers -id Unique identifier of the XtremIO consistency group.
size Type: size (0 to 9223372036854775807 (8192.00P)) Size of the XtremIO volume, in bytes. severity [Added in 1.0.2] Type: enumerated value ("Clear", "Critical", "Information", "Major", "Minor", "Unknown") Severity level of current alerts for this entity and its contained objects. Values are: Clear No alerts exist for this entity or contained/members. Information The highest severity for this entity and all contained/members is Information.
Unknown The certainty is unknown to PowerStore. Was added in version 1.0.2. is_read_only Type: boolean Indicates whether the XtremIO volume is a read only volume. is_replication_destination Type: boolean Indicates whether the XtremIO volume is a replication destination.
[Added in 1.0.2] severity_l10n Type: string Localized message string corresponding to severity Was added in version 1.0.2. certainty_l10n [Added in 1.0.2] Type: string Localized message string corresponding to certainty Was added in version 1.0.2. importable_criteria_l10n [Added in 1.0.2] Type: string Localized message string corresponding to importable_criteria Was added in version 1.0.2. import_xtremio [Added in 1.0.2] This is the embeddable reference form of import_xtremio_id attribute.
Attribute Select Sort Search import_xtremio.platform_l10n X import_xtremio.serial_number X import_xtremio.severity X import_xtremio.severity_l10n X import_xtremio.software_version X import_xtremio.state X import_xtremio.state_l10n X import_xtremio.supported_import_type X import_xtremio.supported_import_type_l10n X import_xtremio.user_name X import_xtremio.xms_version X import_xtremio_consistency_group.id X import_xtremio_consistency_group.
Attribute Select Sort Search is_read_only X X X is_replication_destination X X X name X X X severity X X X severity_l10n X X X size X X X wwn X X X Format import_xtremio_volume [ { -id | -name } ] show [ -select ,… ] [ -sort [+|-],… ] [ -offset ] [ { -limit | -all } ] [ -query ] [ -output { nvp | csv [ -table ] [ -noformat ] | table | json [ -raw ] } ] Action qualifiers -id Unique identifier of the XtremIO volume.
-query Query records that fulfill the specified condition. -output Change the output format. nvp Display output as plain text. csv Display output in CSV format. table Display output in a table. json Display output in JSON format. import_snapshot_schedules [Added in 1.0.2] Return the snapshot schedules associated with the specified XtremIO volume. Was added in version 1.0.2.
created_timestamp Type: date time Time at which recommendation was created. state Type: enumerated value ("Migration_Error", "Migration_Session_Create_Failed", "Migration_Start_Failed", "Migration_Paused", "Migration_Session_Created", "Migration_Started", "Migration_Successful", "Recommendation_Created", "Some_Actions_Recommended") State of a migration recommendation. Recommendation_Created Recommended actions meet all request parameters.
Migration_Error At least one migration session for this recommendation has failed. Migration_Successful All migration sessions have been successfully completed. Values was added in 2.0.0.0: Migration_Start_Failed. estimated_cost Type: 64-bit signed integer (0 to 9223372036854775807) Unitless value describing estimated cost to migrate all volumes for this recommendation relative to other recommendations.
Filtering on the fields of this embedded resource is not supported. See migration_actions for more details state_l10n Type: string Localized message string corresponding to state. type_l10n Type: string Localized message string corresponding to type. Attributes of request_parameters evacuate_appliance Evacuate appliance by specifying optional space_to_free See evacuate_appliance for more details evacuate_objects [Added in 2.0.0.0] Evacuate appliance by migrating specified storage objects.
action_state State of a recommended migration action. Recommendation_Created This action has been recommended, but no other action has been taken. Migration_Session_Created A migration session was successfully created for this recommended action. Migration_Session_Create_Failed A migration session could not be created for this recommended action. Migration_Started The migration session for this recommended action was successfully started.
volume Standalone attached/unattached volume family. virtual_volume Standalone attached/unattached virtual volume family. host Logical group of all volume families attached to a host. virtual_machine Logical group of all virtual volume families attached to a virtual machine. volume_group Volume group family with or without host attachment. migration_reason Reason for migrating a specific resource. No_Host_Attached Resource is not attached to any host.
migration_reason_l10n Localized message string corresponding to migration_reason Attributes of evacuate_appliance appliance_id ID of appliance on which available space is desired. space_to_free Optional desired amount of used storage (in bytes) to move to other appliances. If space_to_free is not specified, space to be freed is estimated by the system such that migrating objects equivalent to that much amount of storage space would clear Major severity capacity alarm on the appliance.
resource_type Resource type resource_ids List of resource ids to be evacuated show Property capabilities Attribute Select Sort Search created_timestamp X X X estimated_cost X X X id X X X migration_actions X X X request_parameters X X X rescan_host_list X X X sessions_completed_timestamp X X X sessions_created_timestamp X X X state X X X state_l10n X X X type X X X type_l10n X X X Format migration_recommendation [ -id ] show [ -select ,… ]
-select Display selected attributes in the output. -sort Sorts output field+ (or just field) sort by field in ascending order. field- sort by field in descending order. -offset Start record list starting from specific value. -limit Limits the number of listed records. -all Query all records. -query Query records that fulfill the specified condition. -output Change the output format. nvp Display output as plain text. csv Display output in CSV format. table Display output in a table.
-evacuate_appliance Evacuate appliance by specifying optional space_to_free -appliance_id ID of appliance on which available space is desired. -space_to_free Optional desired amount of used storage (in bytes) to move to other appliances. If space_to_free is not specified, space to be freed is estimated by the system such that migrating objects equivalent to that much amount of storage space would clear Major severity capacity alarm on the appliance.
cluster. -async Perform asynchronous operation. delete Delete a migration recommendation. Format migration_recommendation -id delete [ -async ] Action qualifiers -id Unique ID of the migration recommendation. -async Perform asynchronous operation. [Added in 2.0.0.0] set Modify migration actions by applying specified dst appliance id and active flag to the migration actions specified by resource id. All specified modifications must be successful for the request to be successful.
-async Perform asynchronous operation. create_migration_sessions Create the migration sessions to implement a migration recommendation. If the response contains a list of hosts to rescan, those hosts must be rescanned before starting the sessions or the host(s) may lose access to the data when the migration completes. Format migration_recommendation -id create_migration_sessions [ -async ] Action qualifiers -id Unique ID of the migration recommendation. -async Perform asynchronous operation.
name Type: string User-specified friendly name of the migration session instance. This property supports caseinsensitive filtering. resource_type Type: enumerated value ("virtual_volume", "volume", "volume_group") Storage resource types eligible for migration. source_appliance_id Type: string Unique identifier of the source appliance instance. family_id Type: string Family identifier designating the storage resource or resources being migrated.
Cutting_Over Final phase of the migration, when ownership of the volume, vVol, or application group is transferred to the new appliance. Deleting Migration session is being deleted. Completed Migration session is complete and it is safe to delete the session. Pausing Migration session transitions to this state when the pause command is issued. Paused Migration session is paused. User intervention is required to resume the session.
resource_type_l10n Type: string Localized message string corresponding to resource_type. state_l10n Type: string Localized message string corresponding to state. virtual_volumes This is the inverse of the resource type virtual_volume association. See virtual_volume for more details volumes This is the inverse of the resource type volume association. See volume for more details replication_sessions This is the inverse of the resource type replication_session association.
Attribute Select Sort Search progress_percentage X X X replication_sessions.estimated_completion_timestamp X replication_sessions.failover_test_in_progress X replication_sessions.id X replication_sessions.last_sync_duration X replication_sessions.last_sync_timestamp X replication_sessions.local_resource_id X replication_sessions.next_sync_timestamp X replication_sessions.progress_percentage X replication_sessions.remote_resource_id X replication_sessions.
Attribute Select Sort Search source_appliance_id X X X state X X X state_l10n X X X virtual_volumes.appliance_id X virtual_volumes.creation_timestamp X virtual_volumes.creator_type X virtual_volumes.creator_type_l10n X virtual_volumes.family_id X virtual_volumes.id X virtual_volumes.io_priority X virtual_volumes.io_priority_l10n X virtual_volumes.is_readonly X virtual_volumes.location_history X virtual_volumes.migration_session_id X virtual_volumes.
Attribute Select virtual_volumes.type X virtual_volumes.type_l10n X virtual_volumes.usage_type X virtual_volumes.usage_type_l10n X virtual_volumes.virtual_machine_uuid X volume_groups.creation_timestamp X volume_groups.description X volume_groups.id X volume_groups.is_importing X volume_groups.is_protectable X volume_groups.is_replication_destination X volume_groups.is_write_order_consistent X volume_groups.location_history X volume_groups.migration_session_id X volume_groups.
Attribute Select volumes.creation_timestamp X volumes.description X volumes.id X volumes.is_replication_destination X volumes.location_history X volumes.migration_session_id X volumes.name X volumes.nguid X volumes.node_affinity X volumes.node_affinity_l10n X volumes.nsid X volumes.performance_policy_id X volumes.protection_data X volumes.protection_policy_id X volumes.size X volumes.state X volumes.state_l10n X volumes.type X volumes.type_l10n X volumes.
[+|-],… ] [ -offset ] [ { -limit | -all } ] [ -query ] [ -output { nvp | csv [ -table ] [ -noformat ] | table | json [ -raw ] } ] Action qualifiers -id Unique identifier of the migration session. -name Unique name of the existing object (migration_session). -select Display selected attributes in the output. -sort Sorts output field+ (or just field) sort by field in ascending order. field- sort by field in descending order.
during this phase and the ownership of the vVol is transferred to the new appliance. For volumes and application groups, a migration session is created in this phase and no background copy is performed until either the sync or cutover operation is invoked. There are no interruptions to any services during this phase.
-name Unique name of the existing object (migration_session). -force Indicates whether all migration activities will be canceled before deleting the session. -async Perform asynchronous operation. cutover Final phase of the migration, when ownership of the volume, vVol, or volume group is transferred to the new appliance. Format migration_session { -id | -name } cutover [ -async ] Action qualifiers -id Unique identifier of the migration session.
resume Resume a paused migration session. You cannot resume a migration session in the failed state. Format migration_session { -id | -name } resume [ -async ] Action qualifiers -id Unique identifier of the migration session. -name Unique name of the existing object (migration_session). -async Perform asynchronous operation. sync Synchronize a migration session. During this phase, the majority of the background copy is completed and there are no interruptions to any services.
Monitoring View event logs and alerts alert Use these resource types to manage events and alerts in the system. An alert is a summation of one or more events that need (or needed) attention. Some events require attention and result in an alert being generated. Other events can update or clear an alert when the system detects a change in the condition that needs attention. To deal with an alert, look at the information about the most recent event included in the alert.
"node", "ntp", "performance_rule", "physical_switch", "policy", "remote_syslog_server", "remote_system", "replication_rule", "replication_session", "role", "sas_port", "scheduler", "security_config", "service_config", "service_user", "smb_server", "smb_share", "smtp_config", "snapshot_rule", "software_installed", "software_package", "veth_port", "storage_container", "virtual_machine", "system_health_check", "virtual_volume", "volume", "vcenter", "volume_group", "x509_certificate") Type of the r
called_home_timestamp Type: date time Timestamp when the event resulted in a notification to support (via Secured Remote Services), if any. email_sent_timestamp Type: date time Timestamp when the email was sent for the raised alert, if any. [Added in 2.0.0.0] snmp_sent_timestamp Type: date time Timestamp when the SNMP trap was sent for the raised alert, if any. Was added in version 2.0.0.0. acknowledged_timestamp Type: date time Timestamp when the alert was acknowledged, if any.
event_code Identifies the specific kind of event that has occurred. severity The severity of the event. resource_type The type of the object which generated this event. resource_id Unique identifier of the resource instance which generated this event. resource_name Name of the resource instance which generated this event. This property supports caseinsensitive filtering. generated_timestamp Timestamp at which this event occured. description_l10n Description of this event.
Attribute Select Sort Search email_sent_timestamp X X X event_code X X X events X X X generated_timestamp X X X id X X X is_acknowledged X X X raised_timestamp X X X resource_id X X X resource_name X X X resource_type X X X resource_type_l10n X X X severity X X X severity_l10n X X X snmp_sent_timestamp X X X state X X X state_l10n X X X Format alert [ -id ] show [ -select ,… ] [ -sort [+|-],… ] [ -offset ]
-sort Sorts output field+ (or just field) sort by field in ascending order. field- sort by field in descending order. -offset Start record list starting from specific value. -limit Limits the number of listed records. -all Query all records. -query Query records that fulfill the specified condition. -output Change the output format. nvp Display output as plain text. csv Display output in CSV format. table Display output in a table. json Display output in JSON format. set Modify an alert.
-is_acknowledged Indicates whether the alert has been acknowledged. -acknowledged_severity Possible severities. -async Perform asynchronous operation. event Use these resource types to manage events and alerts in the system. An event indicates that something of interest happened in the system. Normally, an event that requires attention will generate an alert as well. So, although they may be interesting for troubleshooting, it is not necessary to monitor events.
"migration_session", "nas_server", "ndu", "network", "nfs_export", "nfs_server", "node", "ntp", "performance_rule", "physical_switch", "policy", "remote_syslog_server", "remote_system", "replication_rule", "replication_session", "role", "sas_port", "scheduler", "security_config", "service_config", "service_user", "smb_server", "smb_share", "smtp_config", "snapshot_rule", "software_installed", "software_package", "veth_port", "storage_container", "virtual_machine", "system_health_check", "virtual_vo
Localized message string corresponding to resource_type.
field+ (or just field) sort by field in ascending order. field- sort by field in descending order. -offset Start record list starting from specific value. -limit Limits the number of listed records. -all Query all records. -query Query records that fulfill the specified condition. -output Change the output format. nvp Display output as plain text. csv Display output in CSV format. table Display output in a table. json Display output in JSON format.
"snapshot", "sync", "start_failover_test", "test", "upgrade", "time_to_full", "upload", "start_migration_sessions", "unjoin", "unmount", "upload_certificate", "stop_failover_test", "update_user_mappings", "upload_config", "upload_file", "upload_keytab", "verify") User-specified action to be performed on the given resource. Values was added in 2.0.0.0: start_failover_test, stop_failover_test.
Description of the job. [Deprecated in 1.0.2] state Type: enumerated value ("COMPLETED", "FAILED", "FAILING", "IN_PROGRESS", "PENDING", "QUEUED", "SKIPPED", "UNRECOVERABLE_FAILED") Was deprecated in version 1.0.2. start_time Type: date time Date and time when the job execution started. [Added in 1.0.2] phase Type: enumerated value ("Completed", "Failed", "Failing", "In_Progress", "Pending", "Queued", "Skipped", "Unrecoverable_Failed") Was added in version 1.0.2.
response_body Type: object Base response object Filtering on the fields of this embedded resource is not supported. May be one of the following types: [Added in 2.0.0.0] ◦ job_appliance_create_error_response ◦ job_appliance_forecast_response ◦ job_appliance_time_to_full_response [Added in 2.0.0.0] ◦ job_appliance_validate_create_response [Added in 2.0.0.
[Added in 2.0.0.0] response_status Type: enumerated value ("200", "201", "202", "204", "206", "207", "400", "401", "403", "404", "405", "406", "415", "416", "422", "500", "503") Was added in version 2.0.0.0. step_order Type: 32-bit signed integer (0 to 2147483647) Order of a given job step with respect to its siblings within the job hierarchy. resource_action_l10n Type: string Localized message string corresponding to resource_action.
messages See messages for more details issues See issues [Added in 2.0.0.0] for more details Attributes of job_appliance_forecast_response timestamp Date-time of the forecast data. low_value Estimate for the lower bound forecasted value on that particular time. mean_value Estimate for the mean forecasted value on that particular time. high_value Estimate for the upper bound forecasted value on that particular time. Attributes of job_appliance_time_to_full_response appliance_id Unique ID of appliance.
Major Time to full value is less than or equal to 14 days. Major alert indicated. None There is insufficient forecast data to project time to full to at least 28 days. No alert indicated, but available data cannot guarantee OK status. time_to_full_status_l10n Localized message string corresponding to time_to_full_status [Added in 2.0.0.0] Attributes of job_appliance_validate_create_response issues See issues [Added in 2.0.0.0] for more details [Added in 2.0.0.
time_to_full_pessimistic Pessimistic date-time for time to full based on the upper bound of the forecast 95% confidence interval. time_to_full_optimistic Optimistic date-time for time to full based on the lower bound of the forecast 95% confidence interval. time_to_full_status Type of alert indicated for object based on projected time to full. OK Time to full value is greater than 28 days. No alert indicated. Minor Time to full value is less than or equal to 28 days but greater than 14 days.
Attributes of job_file_system_snapshot_response id The unique identifier of the created snapshot. Attributes of job_job_response id The id of the job created by the request. Attributes of job_keystore_archive_regenerate_response download_uri A Uniform Resource Identifier which can be used in a subsequent GET request to download the keystore backup archive file.
Attributes of job_volume_group_refresh_response backup_snapshot_id Unique identifier of the backup snapshot set. This parameter will not be available if the create_backup_snap flag was set to false. Attributes of job_volume_group_restore_response backup_snapshot_id Unique identifier of the backup snapshot set. This parameter will not be available if the create_backup_snap was set to false.
Client Client Certificate CA Client Validation A CA certificate used to authenticate clients during an SSL handshake. CA Server Validation A CA certificate used to verify the server during an SSL handshake. service Type of the service for which the certificate is used: Management HTTP Management Web server Replication HTTP Remote Replication service VASA HTTP VASA provider service Import HTTP External web service Values was added in 1.0.3: LDAP_HTTP, Syslog_HTTP.
members Member certificates included in this x509_certificate. It will be empty in csr creation response. See members for more details certificate_request PEM encoded certificate signing request. type_l10n [Added in 2.0.0.0] Localized message string corresponding to type Was added in version 2.0.0.0. [Added in 2.0.0.0] service_l10n Localized message string corresponding to service Was added in version 2.0.0.0. Attributes of messages code Hexadecimal error code of the message. severity Message severity.
Attributes of messages code Hexadecimal error code of the message. severity Message severity. message_l10n The message description in the specified locale with arguments substituted. arguments Arguments (if applicable) for the error message. Attributes of issues [Added in 2.0.0.0] reason Error message for an operation. See reason for more details resolution Error message for an operation. See resolution for more details appliance_id The appliance on which the issue was detected.
Attributes of members subject Certificate subject or so called distinguished name. serial_number Certificate serial number. signature_algorithm Certificate signature algorithm. issuer Distinguished name of the certificate issuer. valid_from Date and time when the certificate becomes valid. valid_to Date and time when the certificate will expire. subject_alternative_names Additional DNS names or IP addresses in the x509_certificate. public_key_algorithm Public key algorithm used to generate the key pair.
Attributes of reason code Hexadecimal error code of the message. severity Message severity. message_l10n The message description in the specified locale with arguments substituted. arguments Arguments (if applicable) for the error message. Attributes of resolution code Hexadecimal error code of the message. severity Message severity. message_l10n The message description in the specified locale with arguments substituted. arguments Arguments (if applicable) for the error message.
message_l10n The message description in the specified locale with arguments substituted. arguments Arguments (if applicable) for the error message. Attributes of reason code Hexadecimal error code of the message. severity Message severity. message_l10n The message description in the specified locale with arguments substituted. arguments Arguments (if applicable) for the error message. Attributes of resolution code Hexadecimal error code of the message. severity Message severity.
code Hexadecimal error code of the message. severity Message severity. message_l10n The message description in the specified locale with arguments substituted. arguments Arguments (if applicable) for the error message. show Property capabilities Attribute Select children.description_l10n X children.end_time X children.estimated_completion_time X children.id X children.parent_id X children.phase X children.phase_l10n X children.progress_percentage X children.resource_action X children.
Attribute Select Sort Search children.response_body X children.response_status X children.response_status_l10n X children.root_id X children.start_time X children.state X children.state_l10n X children.step_order X children.user X description_l10n X X X end_time X X X estimated_completion_time X X X id X X X leafs.description_l10n X leafs.end_time X leafs.estimated_completion_time X leafs.id X leafs.parent_id X leafs.phase X leafs.phase_l10n X leafs.
Attribute Select leafs.resource_action X leafs.resource_action_l10n X leafs.resource_id X leafs.resource_name X leafs.resource_type X leafs.resource_type_l10n X leafs.response_body X leafs.response_status X leafs.response_status_l10n X leafs.root_id X leafs.start_time X leafs.state X leafs.state_l10n X leafs.step_order X leafs.user X parent.description_l10n X parent.end_time X parent.estimated_completion_time X parent.id X parent.parent_id X parent.
Attribute Select Sort Search parent.phase_l10n X parent.progress_percentage X parent.resource_action X parent.resource_action_l10n X parent.resource_id X parent.resource_name X parent.resource_type X parent.resource_type_l10n X parent.response_body X parent.response_status X parent.response_status_l10n X parent.root_id X parent.start_time X parent.state X parent.state_l10n X parent.step_order X parent.
Attribute Select Sort Search resource_action X X X resource_action_l10n X X X resource_id X X X resource_name X X X resource_type X X X resource_type_l10n X X X response_body X X X response_status X X X response_status_l10n X X X root.description_l10n X root.end_time X root.estimated_completion_time X root.id X root.parent_id X root.phase X root.phase_l10n X root.progress_percentage X root.resource_action X root.resource_action_l10n X root.
Attribute Select Sort Search root.resource_type X root.resource_type_l10n X root.response_body X root.response_status X root.response_status_l10n X root.root_id X root.start_time X root.state X root.state_l10n X root.step_order X root.
-select Display selected attributes in the output. -sort Sorts output field+ (or just field) sort by field in ascending order. field- sort by field in descending order. -offset Start record list starting from specific value. -limit Limits the number of listed records. -all Query all records. -query Query records that fulfill the specified condition. -output Change the output format. nvp Display output as plain text. csv Display output in CSV format. table Display output in a table.
in 2.0.0.0] performance_metrics_by_fe_fc_node | wear_metrics_by_drive[Deprecated | [Added in 2.0.0.
space_metrics_by_cluster Cluster space metrics space_metrics_by_appliance Appliance space metrics space_metrics_by_volume Volume space metrics space_metrics_by_volume_family Volume family space metrics space_metrics_by_vm Virtual Machine space metrics space_metrics_by_storage_container Storage Container space metrics space_metrics_by_vg Volume space metrics in a volume group copy_metrics_by_appliance Appliance copy metrics copy_metrics_by_cluster Cluster copy metrics copy_metrics_by_vg Co
performance_metrics_smb2_builtinclie Performance metrics for the SMB2 nt_by_node protocol built-in client performance_metrics_nfs_by_node Performance metrics for the NFS protocol performance_metrics_nfsv3_by_node Performance metrics for the NFSv3 metrics for the NFSv4 protocol performance_metrics_nfsv4_by_node Performance protocol performance_metrics_file_by_node Performance metrics for file by node. performance_metrics_file_by_appliance Performance metrics for file by appliance.
Attributes id Type: string Unique remote syslog server identifier. remote_server_address Type: string IPv4 or IPv6 address, or DNS name of the log server. port Type: 32-bit signed integer (0 to 65535) Port used for connection to the remote server. protocol_type [Added in 2.0.0.0] Type: enumerated value ("TCP", "UDP") Available protocol types. TCP Use the Transmission Control Protocol. UDP Use the User Datagram Protocol. Was added in version 2.0.0.0. encryption [Added in 2.0.0.
If true, then this instance will receive audit messages. [Added in 2.0.0.0] status Type: enumerated value ("Connected", "Not_Connected") The status of the remote syslog server. Connected The system can be connected to. Not_Connected The system cannot be connected to. Was added in version 2.0.0.0. protocol_type_l10n [Added in 2.0.0.0] Type: string Localized message string corresponding to protocol_type Was added in version 2.0.0.0. encryption_l10n [Added in 2.0.0.
Attribute Select Sort Search is_enabled X X X port X X X protocol_type X X X protocol_type_l10n X X X remote_server_address X X X status X X X status_l10n X X X Format remote_syslog_server [ -id[Added in 2.0.0.0] ] show [ -select ,… ] [ -sort [+|-],… ] [ -offset ] [ { -limit | -all } ] [ -query ] [ -output { nvp | csv [ -table ] [ -noformat ] | table | json [ -raw ] } ] Action qualifiers [Added in 2.0.0.
-output Change the output format. nvp Display output as plain text. csv Display output in CSV format. table Display output in a table. json Display output in JSON format. [Added in 2.0.0.0] create Create a remote_syslog_server object. Was added in version 2.0.0.0. Format remote_syslog_server create -remote_server_address -port <0..
None Do not enforce security when transmitting audit logs. Was added in version 2.0.0.0. -is_enabled If true, then this instance will receive audit messages. -async Perform asynchronous operation. delete [Added in 2.0.0.0] Delete a remote_syslog_server object. Was added in version 2.0.0.0. Format remote_syslog_server -id delete [ -async ] Action qualifiers -id Unique identifier of the remote syslog server object. -async Perform asynchronous operation. [Added in 2.0.0.
TCP Use the Transmission Control Protocol. UDP Use the User Datagram Protocol. Was added in version 2.0.0.0. -encryption Available encryption types. TLS Create a private connection via Transport Layer Security. None Do not enforce security when transmitting audit logs. Was added in version 2.0.0.0. -audit_types Audit type selections. If empty, all types will be sent to the remote log server. Otherwise, only audit events of the specified type(s) will be sent.
policy Use this resource type to manage protection policies and to view information about performance policies. Note: Performance policies are predefined for high, low, and medium performance. They cannot be added to or changed. Properties of a policy. This resource type has queriable associations from performance_rule, snapshot_rule, replication_rule, virtual_machine, volume, volume_group, file_system Attributes id Type: string Unique identifier of the policy. name Type: string Policy name.
more details volumes This is the inverse of the resource type volume association. See volume for more details volume_groups This is the inverse of the resource type volume_group association. See volume_group for more details file_systems This is the inverse of the resource type file_system association. See file_system for more details performance_rules List of the performance_rules that are associated with this policy.
Attribute Select file_systems.default_hard_limit X file_systems.default_soft_limit X file_systems.description X file_systems.expiration_timestamp X file_systems.filesystem_type X file_systems.filesystem_type_l10n X file_systems.folder_rename_policy X file_systems.folder_rename_policy_l10n X file_systems.grace_period X file_systems.id X file_systems.is_async_MTime_enabled X file_systems.is_modified X file_systems.is_quota_enabled X file_systems.
Attribute Select Sort Search file_systems.locking_policy_l10n X file_systems.name X file_systems.nas_server_id X file_systems.parent_id X file_systems.protection_policy_id X file_systems.size_total X file_systems.size_used X file_systems.smb_notify_on_change_dir_depth X id X X X is_replica X X X name X X X performance_rules.id X performance_rules.io_priority X performance_rules.io_priority_l10n X performance_rules.name X replication_rules.
Attribute Select Sort Search replication_rules.rpo_l10n X snapshot_rules.days_of_week X snapshot_rules.days_of_week_l10n X snapshot_rules.desired_retention X snapshot_rules.id X snapshot_rules.interval X snapshot_rules.interval_l10n X snapshot_rules.is_replica X snapshot_rules.name X snapshot_rules.time_of_day X snapshot_rules.timezone X snapshot_rules.timezone_l10n X type X X X type_l10n X X X virtual_machines.cpu_count X virtual_machines.
Attribute Select virtual_machines.memory_mb X virtual_machines.name X virtual_machines.protection_data X virtual_machines.protection_policy_id X virtual_machines.status X virtual_machines.status_l10n X virtual_machines.type X virtual_machines.type_l10n X virtual_machines.vcenter_id X virtual_machines.vcenter_instance_uuid X volume_groups.creation_timestamp X volume_groups.description X volume_groups.id X volume_groups.is_importing X volume_groups.
Attribute Select volume_groups.protection_data X volume_groups.protection_policy_id X volume_groups.type X volume_groups.type_l10n X volumes.appliance_id X volumes.creation_timestamp X volumes.description X volumes.id X volumes.is_replication_destination X volumes.location_history X volumes.migration_session_id X volumes.name X volumes.nguid X volumes.node_affinity X volumes.node_affinity_l10n X volumes.nsid X volumes.performance_policy_id X volumes.
Attribute Select volumes.state_l10n X volumes.type X volumes.type_l10n X volumes.wwn X Sort Search Format policy [ { -id | -name } ] show [ -select ,… ] [ -sort [+|-],… ] [ -offset ] [ { -limit | -all } ] [ -query ] [ -output { nvp | csv [ -table ] [ -noformat ] | table | json [ -raw ] } ] Action qualifiers -id Unique identifier of the policy. -name Unique name of the existing object (policy).
nvp Display output as plain text. csv Display output in CSV format. table Display output in a table. json Display output in JSON format. create Create a new protection policy. Protection policies can be assigned to volumes or volume groups. When a protection policy is assigned to a volume or volume group: • If the policy is associated with one or more snapshot rules, scheduled snapshots are created based on the schedule specified in each snapshot rule.
Format policy -id delete [ -async ] Action qualifiers -id Unique identifier of the protection policy to be deleted. -async Perform asynchronous operation. set Modify a protection policy.
-remove_snapshot_rule_ids Snapshot rule identifiers to be removed from this policy. -remove_replication_rule_ids Replication rule identifiers to be removed from this policy. -async Perform asynchronous operation. remote_system Information about remote storage systems that connect to the local PowerStore system. The system uses the configuration to access and communicate with the remote system for management and data transfer communications.
[Added in 2.0.0.0] version Type: string Version of the remote system. Was added in version 2.0.0.0. management_address Type: string Management IP address of the remote system instance. type Type: enumerated value ("PS_Equallogic", "PowerStore", "Storage_Center", "Unity", "VNX", "XtremIO") Type of the remote system. user_name Type: string Username used to access the non-PowerStore remote systems.
data_network_latency Type: enumerated value ("High", "Low") Network latency for the remote system. data_connections Type: array of objects List of data connections from each appliance in the local cluster to iSCSI target IP address. Filtering on the fields of this embedded resource is not supported. See data_connections for more details type_l10n Type: string Localized message string corresponding to type. state_l10n Type: string Localized message string corresponding to state.
replication_session for more details Attributes of data_connections node_id Unique identifier of the local, initiating node. initiator_address Initiating address from the local node. target_address Target address from the remote system. status Status of the data connection.
Attribute Select import_sessions.current_transfer_rate X import_sessions.description X import_sessions.destination_resource_id X import_sessions.destination_resource_type X import_sessions.destination_resource_type_l10n X import_sessions.error X import_sessions.estimated_completion_timestamp X import_sessions.id X import_sessions.last_update_timestamp X import_sessions.name X import_sessions.parent_session_id X import_sessions.progress_percentage X import_sessions.
Attribute Select Sort Search iscsi_addresses X X X management_address X X X name X X X replication_sessions.estimated_completion_timestamp X replication_sessions.failover_test_in_progress X replication_sessions.id X replication_sessions.last_sync_duration X replication_sessions.last_sync_timestamp X replication_sessions.local_resource_id X replication_sessions.next_sync_timestamp X replication_sessions.progress_percentage X replication_sessions.
Attribute Select Sort Search serial_number X X X session_chap_mode X X X session_chap_mode_l10n X X X state X X X state_l10n X X X type X X X type_l10n X X X user_name X X X version X X X Format remote_system [ { -id | -name } ] show [ -select ,… ] [ -sort [+|-],… ] [ -offset ] [ { -limit | -all } ] [ -query ] [ -output { nvp | csv [ -table ] [ -noformat ] | table | json [ -raw ] } ] Action qualifiers -id Uni
-limit Limits the number of listed records. -all Query all records. -query Query records that fulfill the specified condition. -output Change the output format. nvp Display output as plain text. csv Display output in CSV format. table Display output in a table. json Display output in JSON format. create Create a new remote system relationship. The type of remote system being connected requires different parameter sets.
Management address Either an IPv4 or IPv6 address. FQDN is not supported. • Type of remote system • Name • Description • Remote administrator credentials iSCSI address IPv4 address • CHAP mode for discovery or session • CHAP secrets details After the remote system relationship is created, the local system can communicate with the remote system, and open data connections for data transfer.
-remote_password Password used to access the remote system. Used only for non-PowerStore systems. -remote_passwordSecure Secure version of -remote_password. Value will be queried interactively. -iscsi_addresses iSCSI target IP addresses for the data connection to the remote system. Must be specified when creating a non-PowerStore remote system. -import_chap_info Chap information to be used for session and discovery. This is applicable to non-PowerStore remote systems.
-initiator_discovery_username Username used by the initiator to authenticate the target during discovery authentication. Mutual CHAP mode only. -initiator_discovery_password Password used by the initiator to authenticate the target during discovery authentication. Mutual CHAP mode only. -initiator_discovery_passwordSecure Secure version of -initiator_discovery_password. Value will be queried interactively. -discovery_chap_mode Indicates the chap mode to be used during discovery.
-async Perform asynchronous operation. set Modify a remote system instance. The list of valid parameters depends on the type of remote system. For PowerStore remote system relationships: • Description Management address An IPv4 or IPv6 address. FQDN is not supported. For non-PowerStore remote system relationships: • Name • Description Management address An IPv4 address. FQDN is not supported. • Remote administrator credentials iSCSI address An IPv4 address.
-management_address Management IP address of the remote system. -remote_username Username used to access the remote system. Used only for non-PowerStore systems. -remote_password Password used to access the remote system. Used only for non-PowerStore systems. -remote_passwordSecure Secure version of -remote_password. Value will be queried interactively. -data_network_latency Network latency for the PowerStore remote system. -async Perform asynchronous operation.
id Type: string Unique identifier of the replication rule. name Type: string Name of the replication rule. This property supports case-insensitive filtering. rpo Type: enumerated value ("Fifteen_Minutes", "Five_Minutes", "One_Day", "One_Hour", "Six_Hours", "Thirty_Minutes", "Twelve_Hours") 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.
show Property capabilities Attribute Select Sort Search alert_threshold X X X id X X X is_replica X X X name X X X policies.description X policies.id X policies.is_replica X policies.name X policies.type X policies.type_l10n X remote_system_id X X X replication_sessions.estimated_completion_timestamp X replication_sessions.failover_test_in_progress X replication_sessions.id X replication_sessions.last_sync_duration X replication_sessions.
Attribute Select Sort Search replication_sessions.remote_system_id X replication_sessions.replication_rule_id X replication_sessions.resource_type X replication_sessions.resource_type_l10n X replication_sessions.role X replication_sessions.role_l10n X replication_sessions.state X replication_sessions.state_l10n X replication_sessions.
field- sort by field in descending order. -offset Start record list starting from specific value. -limit Limits the number of listed records. -all Query all records. -query Query records that fulfill the specified condition. -output Change the output format. nvp Display output as plain text. csv Display output in CSV format. table Display output in a table. json Display output in JSON format. create Create a new replication rule.
-alert_threshold Acceptable delay in minutes 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. Alert threshold has the default value of one RPO in minutes. -async Perform asynchronous operation. delete Delete a replication rule. Deleting a rule is not permitted, if the rule is associated with a protection policy that is currently applied to a storage resource.
Format replication_rule { -id | -name } set [ -name ] [ -rpo { Five_Minutes | Fifteen_Minutes | Thirty_Minutes | One_Hour | Six_Hours | Twelve_Hours | One_Day } ] [ -remote_system_id ] [ -alert_threshold <0..1440> ] [ -async ] Action qualifiers -id Unique identifier of the replication rule. -name Unique name of the existing object (replication_rule). -name Name of the replication rule.
Destination storage resources are in replication destination mode, which disables any write access to the destination resource. Any operations such as resizing the volume, restoring the snapshot, or changing membership for a volume group on the resource are not allowed. On the source end, volumes can be expanded, and volume group membership changes are allowed during any states of a replication session. A replication session.
remote_system_id Type: string Unique identifier of the remote system instance. progress_percentage Type: 32-bit signed integer (0 to 2147483647) Progress of the current replication operation. estimated_completion_timestamp Type: date time Estimated completion time of the current replication operation. replication_rule_id Type: string Associated replication rule instance if created by policy engine. [Added in 2.0.0.
Indicates whether a test failover is in progress at the destination site of this session. Was added in version 2.0.0.0. state_l10n Type: string Localized message string corresponding to state. role_l10n Type: string Localized message string corresponding to role. resource_type_l10n Type: string Localized message string corresponding to resource_type. remote_system This is the embeddable reference form of remote_system_id attribute.
Attribute Select Sort Search estimated_completion_timestamp X X X failover_test_in_progress X X X id X X X last_sync_duration X X X last_sync_timestamp X X X local_resource_id X X X migration_session.created_timestamp X migration_session.current_transfer_rate X migration_session.destination_appliance_id X migration_session.estimated_completion_timestamp X migration_session.family_id X migration_session.id X migration_session.last_sync_timestamp X migration_session.
Attribute Select Sort Search progress_percentage X X X remote_resource_id X X X remote_system.data_connection_state X remote_system.data_connection_state_l10n X remote_system.data_connections X remote_system.data_network_latency X remote_system.data_network_latency_l10n X remote_system.description X remote_system.discovery_chap_mode X remote_system.discovery_chap_mode_l10n X remote_system.id X remote_system.iscsi_addresses X remote_system.management_address X remote_system.
Attribute Select Sort Search remote_system.user_name X remote_system.version X remote_system_id X X X replication_rule.alert_threshold X replication_rule.id X replication_rule.is_replica X replication_rule.name X replication_rule.remote_system_id X replication_rule.rpo X replication_rule.
-id Unique identifier of the replication session. -select Display selected attributes in the output. -sort Sorts output field+ (or just field) sort by field in ascending order. field- sort by field in descending order. -offset Start record list starting from specific value. -limit Limits the number of listed records. -all Query all records. -query Query records that fulfill the specified condition. -output Change the output format. nvp Display output as plain text. csv Display output in CSV format.
failover, stop I/O operations for any applications and hosts. If a synchronization error occurs during a planned failover, the replication session enters the System_Paused state. You cannot pause a replication session during a planned failover. The following operations can be performed during planned failover: • Unplanned failover • Delete the replication session by removing the protection policy on the storage resource After a planned failover, the replication session is in an inactive state.
keep the test data before starting an unplanned failover. Was added in version 2.0.0.0. -failover_snapshot_id [Added in 2.0.0.0] Optional identifier of a snapshot that the destination resource must be restored to as part of an unplanned failover. If a failover_snapshot_id is not specified, the destination will be restored to the last common base snapshot. This identifier is not supported when a failover test is in progress. Was added in version 2.0.0.0.
paused: Pause Use to place both sites into the Paused state Failover Use to get production access from the disaster recovery site • Delete the replication session by removing the protection policy on the storage resource The following system operations may also pause, and subsequently resume, a replication session: • Non-disruptive upgrade • Intra-cluster migration Leaving replication session in a paused state results in change accumulations on the source system, and consume more storage on the source s
synchronization cycle if the session was in the following states when the session was paused: • Synchronizing • System_Paused When only the replication session on the local system is paused, resuming the session pauses both sites. You cannot resume replication sessions paused by the system. The following system operations may also pause, and subsequently resume, a replication session.
• DR_Failover_In_Progress • Failed_Over • Paused_For_NDU • Paused_For_Migration During the test, the following restrictions apply: • Membership changes are not allowed for destination resources that belong to a volume group. • The session cannot be failed over (planned or unplanned). Was added in version 2.0.0.0. Format replication_session -id start_failover_test [ -snapshot_id ] [ -async ] Action qualifiers -id Unique identifier of the replication session. Was added in version 2.0.0.0.
Was added in version 2.0.0.0. -create_end_of_test_snapshot Indicates whether a snapshot of the destination resource should be created at the end of the test. If set to true, the name of the created snapshot will contain a timestamp indicating its time of creation and will be of the format "failover_test_STOPPED_". The snapshot will be set to automatically expire after a system determined interval. -force By default a failover test cannot be stopped if the remote system is not reachable.
Action qualifiers -id Unique identifier of the replication session. -async Perform asynchronous operation. snapshot_rule Use this resource type to manage snapshot rules that are used in protection policies. Snapshot rule instance. This resource type has queriable association from policy Attributes id Type: string Unique identifier of the snapshot rule. name Type: string Snapshot rule name. This property supports case-insensitive filtering.
"AsiaRangoon", "AsiaSeoul", "AsiaSingapore", "AsiaTehran", "AtlanticCape_Verde", "AtlanticReykjavik", "AustraliaAdelaide", "AustraliaBrisbane", "AustraliaDarwin", "AustraliaEucla", "AustraliaLord_Howe", "AustraliaSydney", "BrazilEast", "CST6CDT", "CanadaAtlantic", "CanadaNewfoundland", "ChileContinental", "ChileEasterIsland", "CanadaSaskatchewan", "EST5EDT", "EtcGMT_minus_1", "EtcGMT_minus_10", "EtcGMT_minus_11", "EtcGMT_minus_12", "EtcGMT_minus_13", "EtcGMT_minus_14", "EtcGMT_minus_2", "EtcGMT
days_of_week_l10n Type: array of strings Localized message array corresponding to days_of_week. policies List of the policies that are associated with this snapshot_rule. See policy for more details show Property capabilities Attribute Select Sort Search days_of_week X X X days_of_week_l10n X X X desired_retention X X X id X X X interval X X X interval_l10n X X X is_replica X X X name X X X policies.description X policies.id X policies.is_replica X policies.
Attribute Select Sort Search timezone_l10n X X X Format snapshot_rule [ { -id | -name } ] show [ -select ,… ] [ -sort [+|-],… ] [ -offset ] [ { -limit | -all } ] [ -query ] [ -output { nvp | csv [ -table ] [ -noformat ] | table | json [ -raw ] } ] Action qualifiers -id Unique identifier of the snapshot rule. -name Unique name of the existing object (snapshot_rule). -select Display selected attributes in the output.
table Display output in a table. json Display output in JSON format. create Create a new snapshot rule. Format snapshot_rule create -name -desired_retention <1..8760> [ -interval { Five_Minutes | Fifteen_Minutes | Thirty_Minutes | One_Hour | Two_Hours | Three_Hours | Four_Hours | Six_Hours | Eight_Hours | Twelve_Hours | One_Day } ] [ -time_of_day ] [ -timezone[Added in 2.0.0.
-timezone [Added in 2.0.0.0] Was added in version 2.0.0.0. -days_of_week Days of the week when the rule should be applied. Applies only for rules where the time_of_day parameter is set. -async Perform asynchronous operation. delete Delete a snapshot rule Format snapshot_rule { -id | -name } delete [ -delete_snaps { yes | true | no | false } ] [ -async ] Action qualifiers -id Unique identifier of the snapshot rule. -name Unique name of the existing object (snapshot_rule).
EtcGMT_plus_5 | AmericaCaracas | AmericaCuiaba | AmericaSanto_Domingo | CanadaAtlantic AmericaAsuncion | EtcGMT_plus_4 | CanadaNewfoundland | ChileContinental | BrazilEast AmericaGodthab | AmericaMiquelon | AmericaBuenos_Aires | EtcGMT_plus_3 | AmericaNoronha EtcGMT_plus_2 | AmericaScoresbysund | AtlanticCape_Verde | EtcGMT_plus_1 | UTC | EuropeLondon AfricaCasablanca | AtlanticReykjavik | AntarcticaTroll | EuropeParis | EuropeSarajevo EuropeBelgrade | EuropeRome | AfricaTunis | EtcGMT_minus_1 | AsiaGaza |
Settings Configure general settings on the system including: • Networking • Licensing • Updates audit_event Use this resource type to query audit log information. Attributes id Type: string Unique identifier of the audit log entry. type Type: enumerated value ("Authentication", "Authorization", "Config", "Logout", "System") Type of audit event. Authentication All the authentication events on the system. Authorization All the authorization events on the system.
is_successful Type: boolean Whether the event was successful or not. client_address Type: string FQDN/IP Address of the client from where the event was initiated. server_address Type: string IP Address on which the request was targeted. appliance_id Type: string Unique identifier of the appliance where the event occurred. job_id Type: string Unique identifier of the job associated with the audit event (if any).
Resource Type for the given resource.
show Property capabilities Attribute Select Sort Search appliance_id X X X client_address X X X id X X X is_successful X X X job_id X X X message_arguments X X X message_code X X X message_l10n X X X resource_action X X X resource_action_l10n X X X resource_type X X X resource_type_l10n X X X server_address X X X timestamp X X X type X X X type_l10n X X X username X X X Format audit_event show [ -select ,… ] [ -sort
-select Display selected attributes in the output. -sort Sorts output field+ (or just field) sort by field in ascending order. field- sort by field in descending order. -offset Start record list starting from specific value. -limit Limits the number of listed records. -all Query all records. -query Query records that fulfill the specified condition. -output Change the output format. nvp Display output as plain text. csv Display output in CSV format. table Display output in a table.
id Unique id of the CHAP config settings instance (always "0"). mode Available CHAP modes that describe or set the iSCSI CHAP mode for the entire cluster.
table Display output in a table. json Display output in JSON format. set Modify the CHAP configuration settings object. To enable either Single or Mutual CHAP modes, the username and password must already be set, or included in the same request as the new mode. Format chap_config -id set -mode { Disabled | Single | Mutual } [ -async ] Action qualifiers -id The id of the CHAP configuration object (always "0").
show Property capabilities Attribute Select Sort Search addresses X X X id X X X Format dns [ -id ] show [ -select ,… ] [ -sort [+|-],… ] [ -offset ] [ { -limit | -all } ] [ -query ] [ -output { nvp | csv [ -table ] [ -noformat ] | table | json [ -raw ] } ] Action qualifiers -id Unique identifier of the DNS setting. -select Display selected attributes in the output. -sort Sorts output field+ (or just field) sort by field in ascending order.
csv Display output in CSV format. table Display output in a table. json Display output in JSON format. set Modify a DNS setting. Format dns -id set -addresses ,… [ -async ] Action qualifiers -id Unique identifier of the DNS setting. -addresses DNS server addresses in IPv4 or IPv6 format. -async Perform asynchronous operation. email_notify_destination Use these resource types to configure outgoing SMTP and email notifications.
Whether to send notifications for major alerts. notify_minor Type: boolean Whether to send notifications for minor alerts. notify_info Type: boolean Whether to send notifications for informational alerts.
field- sort by field in descending order. -offset Start record list starting from specific value. -limit Limits the number of listed records. -all Query all records. -query Query records that fulfill the specified condition. -output Change the output format. nvp Display output as plain text. csv Display output in CSV format. table Display output in a table. json Display output in JSON format. create Add an email address to receive notifications.
-notify_info Whether send notifications for informational alerts. -async Perform asynchronous operation. delete Delete an email notification destination. Format email_notify_destination -id delete [ -async ] Action qualifiers -id Unique identifier of the email notification destination. -async Perform asynchronous operation. set Modify an email notification destination.
-notify_info Whether to send notifications for informational alerts. -async Perform asynchronous operation. test Send a test email to an email address. Format email_notify_destination -id test [ -async ] Action qualifiers -id Unique identifier of the email notification destination. -async Perform asynchronous operation. ip_pool_address Use these resource types to scale and reconfigure the IP networks in a cluster. Properties of the IP pool address.
type Storage. appliance_id Type: string Unique identifier of the appliance to which the IP address belongs. node_id Type: string Unique identifier of the cluster node to which the IP address belongs. address Type: string IP address value, in IPv4 or IPv6 format.
Attribute Select Sort Search address X X X appliance.drive_failure_tolerance_level X appliance.drive_failure_tolerance_level_l10n X appliance.express_service_code X appliance.id X appliance.model X appliance.name X appliance.service_tag X appliance_id X X X id X X X ip_port.available_usages X ip_port.available_usages_l10n X ip_port.bond_id X ip_port.current_usages X ip_port.current_usages_l10n X ip_port.eth_port_id X ip_port.id X ip_port.partner_id X ip_port.
Attribute Select Sort Search name X X X network.gateway X network.id X network.ip_version X network.ip_version_l10n X network.mtu X network.name X network.prefix_length X network.purposes X network.purposes_l10n X network.type X network.type_l10n X network.vlan_id X network_id X X X node.appliance_id X node.id X node.
field>[+|-],… ] [ -offset ] [ { -limit | -all } ] [ -query ] [ -output { nvp | csv [ -table ] [ -noformat ] | table | json [ -raw ] } ] Action qualifiers -id Unique identifier of a configured IP address. -name Unique name of the existing object (ip_pool_address). -select Display selected attributes in the output. -sort Sorts output field+ (or just field) sort by field in ascending order. field- sort by field in descending order.
virtual Ethernet ports. This resource type has queriable associations from ip_pool_address, ip_port, bond, eth_port, veth_port Attributes id Type: string Unique identifier of the IP port. partner_id Type: string Identifier of the IP port that is configured on top of physical Ethernet port or virtual Ethernet port or bond with the same physical location on the other node of the appliance. Partner ports are configured symmetrically for HA and load balancing purposes within the appliance.
on top of a bond on a Unified appliance. veth_port_id Type: string Unique identifier of the virtual Ethernet front-end port on top of which the IP port is configured. This attribute can be set when the IP port is used by a Unified+ appliance. For a Unified appliance, the value of veth_port_id should be empty. available_usages_l10n Type: array of strings Localized message array corresponding to available_usages.
Attribute Select Sort Search bond.id X bond.is_link_up X bond.mode X bond.mode_l10n X bond.mtu X bond.name X bond.partner_id X bond.type X bond.type_l10n X bond_id X X X current_usages X X X current_usages_l10n X X X eth_port.appliance_id X eth_port.bond_id X eth_port.current_mtu X eth_port.current_speed X eth_port.current_speed_l10n X eth_port.hardware_parent_id X eth_port.hypervisor_port_id X eth_port.hypervisor_port_name X eth_port.
Attribute Select Sort Search eth_port.hypervisor_vswitch_name X eth_port.id X eth_port.io_module_id X eth_port.is_hypervisor_managed X eth_port.is_link_up X eth_port.mac_address X eth_port.name X eth_port.node_id X eth_port.partner_id X eth_port.port_connector_type X eth_port.port_connector_type_l10n X eth_port.port_index X eth_port.requested_speed X eth_port.requested_speed_l10n X eth_port.sfp_id X eth_port.stale_state X eth_port.stale_state_l10n X eth_port.
Attribute Select ip_pool_addresses.address X ip_pool_addresses.appliance_id X ip_pool_addresses.id X ip_pool_addresses.ip_port_id X ip_pool_addresses.name X ip_pool_addresses.network_id X ip_pool_addresses.node_id X ip_pool_addresses.purposes X ip_pool_addresses.purposes_l10n X partner.available_usages X partner.available_usages_l10n X partner.bond_id X partner.current_usages X partner.current_usages_l10n X partner.eth_port_id X partner.id X partner.partner_id X partner.
Attribute Select veth_port.appliance_id X veth_port.current_mtu X veth_port.current_speed X veth_port.id X veth_port.is_link_up X veth_port.mac_address X veth_port.name X veth_port.node_id X veth_port.partner_id X veth_port.vswitch_name X veth_port.vswitch_port_group_name X veth_port.vswitch_port_id X veth_port.
field+ (or just field) sort by field in ascending order. field- sort by field in descending order. -offset Start record list starting from specific value. -limit Limits the number of listed records. -all Query all records. -query Query records that fulfill the specified condition. -output Change the output format. nvp Display output as plain text. csv Display output in CSV format. table Display output in a table. json Display output in JSON format. set Modify IP port parameters.
Only one IP port on each node can be assigned to the External_Replication usage. Assigning another IP port to this usage will WARNING automatically unassign the currently used IP port on the same node. To unassign an IP port from being used for external replication, choose another IP port and add External_Replication to its list of current usages. -network_id [Added in 2.0.0.0] Unique identifier of the network in which IP port usages will be changed Was added in version 2.0.0.0.
-f Local path with the file name -d Local folder where file shall be stored -filename Filename is the last component in the URI path and becomes the filename of the downloaded file. ldap_account Use this resource type to manage LDAP accounts that map to LDAP users or groups in LDAP server to administrative roles on the PowerStore array. Information about an LDAP account. Was added in version 1.0.3. Attributes id Unique identifier of the LDAP account. name Name of the LDAP account. type [Added in 1.0.
show Property capabilities Attribute Select dn X domain_id X id X name X role_id X type X type_l10n X Sort Search Format ldap_account [ -id ] show [ -select ,… ] [ -output { nvp | csv [ -table ] [ -noformat ] | table | json [ -raw ] } ] Action qualifiers -id Unique identifier of the LDAP account. -select Display selected attributes in the output. -output Change the output format. nvp Display output as plain text. csv Display output in CSV format.
Format ldap_account create -domain_id -name -role_id [ -type { User | Group } ] [ -async ] Action qualifiers -domain_id Unique identifier of the LDAP domain to which LDAP user or group belongs. -name Name of the new LDAP account to be created. The name value can be 1 to 64 UTF-8 characters long, and may only use alphanumeric characters. Dot(.) is the only special character allowed.
Format ldap_account -id set [ -role_id ] [ -async ] Action qualifiers -id Unique identifier of the LDAP account to be modified. -role_id Unique identifier of the new role to which the LDAP account will be mapped. The current login session cannot change its own role. -async Perform asynchronous operation. ldap_domain Use this resource type to manage ldap configuration. Information about an LDAP domain. Was added in version 1.0.3.
LDAP Lightweight directory access protocol\n LDAPS Secure lightweight directory access protocol Was added in version 1.0.3. bind_user Distinguished Name (DN) of the user to be used when binding; that is, authenticating and setting up the connection to the LDAP Server. ldap_timeout Timeout for establishing a connection to an LDAP server. If the system does not receive a reply from the LDAP server after the specified timeout, it stops sending requests. Default value is 30000 (30 seconds).
ldap_server_type_l10n [Added in 1.0.3] Localized message string corresponding to ldap_server_type Was added in version 1.0.3. protocol_l10n [Added in 1.0.3] Localized message string corresponding to protocol Was added in version 1.0.3.
Attribute Select user_object_class X user_search_path X Sort Search Format ldap_domain [ -id ] show [ -select ,… ] [ -output { nvp | csv [ -table ] [ -noformat ] | table | json [ -raw ] } ] Action qualifiers -id Unique identifier of the LDAP domain. -select Display selected attributes in the output. -output Change the output format. nvp Display output as plain text. csv Display output in CSV format. table Display output in a table. json Display output in JSON format.
-ldap_servers List of IP addresses of the LDAP servers for the domain. IP addesses are in IPv4 or IPv6 format. -bind_user Distinguished Name (DN) of the user to be used when binding; that is, authenticating and setting up the connection to the LDAP Server. -bind_password Password to use when binding a new LDAP session. -bind_passwordSecure Secure version of -bind_password. Value will be queried interactively. -user_search_path Path used to search for users on the directory server.
reply from the LDAP server after the specified timeout, it stops sending requests. Default value is 30000 (30 seconds). -is_global_catalog Whether or not the catalog is global. Default value is false. -user_id_attribute Name of the LDAP attribute whose value indicates the unique identifier of the user. Default value is sAMAccountName. -user_object_class LDAP object class for users. Default value is user. -group_name_attribute Name of the LDAP attribute whose value indicates the group name.
[Added in 1.0.3] set Modify the properties of an LDAP domain. Was added in version 1.0.3. Format ldap_domain -id set [ -ldap_servers ,… ] [ -port <0..
-bind_password Password to use when binding a new LDAP session. -bind_passwordSecure Secure version of -bind_password. Value will be queried interactively. -ldap_timeout Timeout for establishing a connection to an LDAP server. If the system does not receive a reply from the LDAP server after the specified timeout, it stops sending requests. Default value is 30000 (30 seconds). -is_global_catalog Whether or not the catalog is global. Default value is false.
[Added in 1.0.3] verify verifying the connectivity to the LDAP domain server. Was added in version 1.0.3. Format ldap_domain -id verify [ -async ] Action qualifiers -id Unique identifier of the instance. -async Perform asynchronous operation. license Use this resource type to view and manage the software license for the cluster. Licenses are normally automatically retrieved when the system is configured.
Whether or not the cluster currently has a valid license. trial_expiration_timestamp Type: date time If not currently licensed, the date the trial period expires. If the trial period expires, new provisioning operations will not be allowed. activation_file_content Type: string The content of the license activation file to send to the DellEMC Software Licensing Central to retrieve the software license for the cluster.
-offset Start record list starting from specific value. -limit Limits the number of listed records. -all Query all records. -query Query records that fulfill the specified condition. -output Change the output format. nvp Display output as plain text. csv Display output in CSV format. table Display output in a table. json Display output in JSON format. retrieve Retrieve the license directly from the DellEMC Software Licensing Central.
-license_file The file to upload containing the software license to install the license on the cluster. -async Perform asynchronous operation. local_user Use this resource type to manage local user accounts. Information about a local user. Attributes id Unique identifier of the local user account. name Name of the local user account. is_built_in Whether the user account is built-in or not. is_locked Whether the user account is locked or not. Defaults to false at creation time.
Attribute Select role_id X Sort Search Format local_user [ -id ] show [ -select ,… ] [ -output { nvp | csv [ -table ] [ -noformat ] | table | json [ -raw ] } ] Action qualifiers -id Unique identifier of the local user account. -select Display selected attributes in the output. -output Change the output format. nvp Display output as plain text. csv Display output in CSV format. table Display output in a table. json Display output in JSON format.
character, one numeric character, and one special character from this list [!,@#$%^*>_~]. -passwordSecure Secure version of -password. Value will be queried interactively. -role_id The unique identifier of the role to which the new local user will be mapped. Where role_id "1" is for Administrator, "2" is for Storage Administrator, "3" is for Operator, "4" is for VM Administrator and "5" is for Security Administrator roles. -async Perform asynchronous operation.
VM Administrator and "5" is for Security Administrator. A local user with either an administration or a security administration role can change the role of any other local user. You cannot change the role of the account you are currently logged-in to. -is_locked Lock or unlock the local user account. Local user with administration/security administration role can lock or unlock any other local user account. You cannot lock an account you are currently logged-in to.
is_built_in_user Indicates whether the logged-in user is predefined. show Property capabilities Attribute Select id X idle_timeout X is_built_in_user X is_password_change_required X role_ids X user X Sort Search Format login_session show [ -select ,… ] [ -output { nvp | csv [ -table ] [ -noformat ] | table | json [ -raw ] } ] Action qualifiers -select Display selected attributes in the output. -output Change the output format. nvp Display output as plain text.
Attributes id Type: string Unique identifier of the network. type Type: enumerated value ("Intra_Cluster_Data", "Intra_Cluster_Management", "Management", "Storage", "VMotion") Network type. Management External cluster and appliance management. Intra_Cluster_Management Management within the cluster. Intra_Cluster_Data Data within the cluster. Storage External data transfer. VMotion Data movement controlled by VMotion. [Added in 2.0.0.0] name Type: string Name of the network.
prefix_length Type: 32-bit signed integer (1 to 127) Network prefix length, used for both IPv4 and IPv6. gateway Type: string Network gateway in IPv4 or IPv6 format, corresponding to the network’s IP version. mtu Type: 32-bit signed integer (1280 to 9000) Maximum Transmission Unit (MTU) packet size set on network interfaces, in bytes. type_l10n Type: string Localized message string corresponding to type. ip_version_l10n Type: string Localized message string corresponding to ip_version.
Attribute Select Sort Search ip_pool_addresses.ip_port_id X ip_pool_addresses.name X ip_pool_addresses.network_id X ip_pool_addresses.node_id X ip_pool_addresses.purposes X ip_pool_addresses.
-select Display selected attributes in the output. -sort Sorts output field+ (or just field) sort by field in ascending order. field- sort by field in descending order. -offset Start record list starting from specific value. -limit Limits the number of listed records. -all Query all records. -query Query records that fulfill the specified condition. -output Change the output format. nvp Display output as plain text. csv Display output in CSV format. table Display output in a table.
Management External cluster and appliance management. Intra_Cluster_Management Management within the cluster. Intra_Cluster_Data Data within the cluster. Storage External data transfer. VMotion Data movement controlled by VMotion. -name Name of the network. -ip_version IP protocol version. -purposes Purposes of the network. This returns a list of purposes for the networks that support multiple purposes per network, like storage network.
delete [Added in 2.0.0.0] Delete network. Was added in version 2.0.0.0. Format network { -id | -name } delete [ -async ] Action qualifiers -id Unique identifier of the network. -name Unique name of the existing object (network). -async Perform asynchronous operation. set Modify IP network parameters, such as gateways, netmasks, VLAN identifiers, and IP addresses. Format network { -id | -name } set [ -vlan_id <0..4094> ] [ -name[Added in 2.0.0.
-prefix_length Network prefix length. (Used for both IPv4 and IPv6). -cluster_mgmt_address ◦ New cluster management IP address in IPv4 or IPv6 format, corresponding to the network’s IP version. ◦ This can only be specified when reconfiguring the management network. Caution Changing the cluster management IP address will lead to losing management sessions through this address. -storage_discovery_address ◦ New storage discovery IP address in IPv4 or IPv6 format, corresponding to the network’s IP version.
-remove_addresses IP addresses to remove in IPv4 or IPv6 format. -force Indicates whether to suppress network validation errors. The option is intended to suppress false errors caused by network environment constraints.
-gateway Network gateway in IPv4 or IPv6 format, corresponding to the network’s IP version. Specify empty string to remove the gateway. -prefix_length Network prefix length. (Used for both IPv4 and IPv6). -cluster_mgmt_address New cluster management IP address in IPv4 or IPv6 format, corresponding to the network’s IP version. -mtu Maximum Transmission Unit (MTU) packet size set on network interfaces, in bytes. -ip_pool_addresses List of new IP addresses in IPv4 or IPv6 format.
PowerStoreX cluster. -address IP address of the SMTP server. -port Port used for sending SMTP messages. -source_email Source email address used for sending SMTP messages. -name Name of a physical switch. -purpose Physical switch purpose in network. Possible purposes are: Data_and_Management Physical switch for all data and management networks. Management_Only Physical switch for management network only. -address Physical switch address in IPv4 or IPv6 or DNS hostname format.
-snmp_community_stringSecure Secure version of -snmp_community_string. Value will be queried interactively. -force Indicates whether to suppress network validation errors. The option is intended to suppress false errors caused by network environment constraints.
Normally the command will fail with an error when: ◦ system network ports on top of which IP ports are configured are in degraded state or have cabling issues, ◦ or network IP addresses applied as a result of network scaling have duplicates in the network environment. When force is true, the command will proceed instead. Caution: Only use this option when you are certain, that your requested settings are correct and you understand why they are failing at this time, and you want to apply the settings anyway.
-id Unique identifier of the NTP setting. -select Display selected attributes in the output. -sort Sorts output field+ (or just field) sort by field in ascending order. field- sort by field in descending order. -offset Start record list starting from specific value. -limit Limits the number of listed records. -all Query all records. -query Query records that fulfill the specified condition. -output Change the output format. nvp Display output as plain text. csv Display output in CSV format.
-id Unique identifier of the NTP setting. -addresses NTP server addresses. This list may contain IPv4 addresses, IPv6 addresses, and host names. -async Perform asynchronous operation. physical_switch Manage physical switches settings for the cluster. This resource type has queriable association from physical_switch_connection Attributes id Type: string Unique identifier of the physical switch setting. name Type: string Name of physical switch. This property supports case-insensitive filtering.
Attribute Select Sort Search connections.address X connections.connect_method X connections.connect_method_l10n X connections.physical_switch_id X connections.port X connections.
-offset Start record list starting from specific value. -limit Limits the number of listed records. -all Query all records. -query Query records that fulfill the specified condition. -output Change the output format. nvp Display output as plain text. csv Display output in CSV format. table Display output in a table. json Display output in JSON format. create Create a physical switch settings.
-connect_method Physical switch connect method type. Valid values are: SSH Secure shell. SNMPv2c SNMPv2 community string. -port Port used for connection to switch. -username Username to connect a physical switch for SSH connection method. -ssh_password SSH password to connect a physical switch if SSH connect method is specified. -ssh_passwordSecure Secure version of -ssh_password. Value will be queried interactively. -snmp_community_string SNMPv2 community string, if SNMPv2c connect method is specified.
set Modify a physical switch settings. Format physical_switch { -id | -name } set [ -name ] [ -purpose Data_and_Management | Management_Only } ] ( [ -connections -address -connect_method SSH | SNMPv2c } [ -port <0..65535> ] [ -username ] [ { -ssh_password -ssh_passwordSecure } ] [ { -snmp_community_string | -snmp_community_stringSecure } ] )… [ -async ] Action qualifiers -id Unique identifier of the physical switch settings.
-ssh_passwordSecure Secure version of -ssh_password. Value will be queried interactively. -snmp_community_string SNMPv2 community string, if SNMPv2c connect method is specified. -snmp_community_stringSecure Secure version of -snmp_community_string. Value will be queried interactively. -async Perform asynchronous operation. role Use these resource types to manage sessions, roles, and system security configurations. Attributes id Unique identifier of the role. name Name of the role.
Action qualifiers -id Unique identifier of the role. -select Display selected attributes in the output. -output Change the output format. nvp Display output as plain text. csv Display output in CSV format. table Display output in a table. json Display output in JSON format. security_config system security configuration System security configuration. Values was added in 2.0.0.0: protocol_mode. Attributes id Unique identifier of the security configuration.
Attribute Select protocol_mode X protocol_mode_l10n X Sort Search Format security_config [ -id ] show [ -select ,… ] [ -output { nvp | csv [ -table ] [ -noformat ] | table | json [ -raw ] } ] Action qualifiers -id Unique identifier of the instance. -select Display selected attributes in the output. -output Change the output format. nvp Display output as plain text. csv Display output in CSV format. table Display output in a table. json Display output in JSON format.
3. TLS 1.2: Only TLS 1.2 is enabled. Was added in version 2.0.0.0. -async Perform asynchronous operation. smtp_config Use these resource types to configure outgoing SMTP and email notifications. Attributes id Type: string Unique identifier of the SMTP configuration. This value is always '0'. address Type: string IP address of the SMTP server. port Type: 32-bit signed integer (0 to 65535) Port used for sending SMTP messages. source_email Type: string Source email address used for sending SMTP messages.
Format smtp_config [ -id ] show [ -select ,… ] [ -sort [+|-],… ] [ -offset ] [ { -limit | -all } ] [ -query ] [ -output { nvp | csv [ -table ] [ -noformat ] | table | json [ -raw ] } ] Action qualifiers -id Unique identifier of the SMTP configuration. This value is always '0'. -select Display selected attributes in the output. -sort Sorts output field+ (or just field) sort by field in ascending order. field- sort by field in descending order.
Format smtp_config -id set [ -address ] [ -port <0..65535> ] [ -source_email ] [ -async ] Action qualifiers -id Unique identifier of the SMTP configuration. This value is always '0'. -address IP address of the SMTP server. -port Port used for sending SMTP messages. -source_email Source email address used for sending SMTP messages. -async Perform asynchronous operation. test Test the SMTP configuration.
Unique identifier of the SNMP server. ip_address Type: string IPv4 address, IPv6 address, or FQDN of the SNMP server. port Type: 32-bit signed integer (0 to 2147483647) Port number to use with the address of the SNMP server. [Added in 2.0.0.0] version Type: enumerated value ("V2c", "V3") Supported SNMP protocol versions: V2c SNMP version 2c, V3 SNMP version 3 Was added in version 2.0.0.0. alert_severity [Added in 2.0.0.
privacy_protocol [Added in 2.0.0.0] Type: enumerated value ("AES256", "None", "TDES") Relevant only for SNMPv3. Supported SNMP privacy protocol: None No encryption on the wire. AES256 Encryption class for AES 256. TDES Privacy protocol class for Triple DES (DESEDE). Was added in version 2.0.0.0. [Added in 2.0.0.0] version_l10n Type: string Localized message string corresponding to version Was added in version 2.0.0.0. alert_severity_l10n [Added in 2.0.0.
Attribute Select Sort Search ip_address X X X port X X X privacy_protocol X X X privacy_protocol_l10n X X X trap_community X X X user_name X X X version X X X version_l10n X X X Format snmp_server [ -id ] show [ -select ,… ] [ -sort [+|-],… ] [ -offset ] [ { -limit | -all } ] [ -query ] [ -output { nvp | csv [ -table ] [ -noformat ] | table | json [ -raw ] } ] Action qualifiers -id Unique identifier of the SNMP server.
-query Query records that fulfill the specified condition. -output Change the output format. nvp Display output as plain text. csv Display output in CSV format. table Display output in a table. json Display output in JSON format. [Added in 2.0.0.0] create Create an SNMP server. Was added in version 2.0.0.0. Format snmp_server create -ip_address -port <162..
-auth_protocol Relevant only for SNMPv3. Supported SNMP authentication protocols: None No authorization. MD5 The AuthMD5 class implements the MD5 authentication protocol. SHA256 The HMAC192SHA256AuthProtocol class implements the Secure Hash Authentication Was added in version 2.0.0.0. -privacy_protocol Relevant only for SNMPv3. Supported SNMP privacy protocol: None No encryption on the wire. AES256 Encryption class for AES 256. TDES Privacy protocol class for Triple DES (DESEDE).
Format snmp_server -id set [ -ip_address ] [ -port <162..49151> ] [ -alert_severity { Info | Minor | Major | Critical } ] [ -trap_community ] [ -user_name ] [ -auth_protocol { None | MD5 | SHA256 } ] [ -privacy_protocol { None | AES256 | TDES } ] [ { -authpass | -authpassSecure } ] [ -async ] Action qualifiers -id Unique identifier of the SNMP server. -ip_address IPv4 address, IPv6 address, or FQDN of the SNMP server.
-authpassSecure Secure version of -authpass. Value will be queried interactively. -async Perform asynchronous operation. [Added in 2.0.0.0] test Send a test notification to a specified SNMP server to verify connectivity. Was added in version 2.0.0.0. Format snmp_server -id test [ -async ] Action qualifiers -id Unique identifier of the SNMP server. -async Perform asynchronous operation. software_installed Software upgrade functionality. Only one upgrade can be active at a time.
Build version of the installed software package release. Was added in version 2.0.0.0. release_timestamp Type: date time Date and time when this software package was produced. installed_date Type: date time Date and time when the software was successfully installed and committed on the cluster. If the software package has not been commited, this value is null. [Added in 2.0.0.0] build_flavor Type: enumerated value ("Retail") Was added in version 2.0.0.0. build_type [Added in 2.0.0.
Attribute Select Sort Search appliance.drive_failure_tolerance_level_l10n X appliance.express_service_code X appliance.id X appliance.model X appliance.name X appliance.
-select Display selected attributes in the output. -sort Sorts output field+ (or just field) sort by field in ascending order. field- sort by field in descending order. -offset Start record list starting from specific value. -limit Limits the number of listed records. -all Query all records. -query Query records that fulfill the specified condition. -output Change the output format. nvp Display output as plain text. csv Display output in CSV format. table Display output in a table.
name Type: string Name of the software package. This property supports case-insensitive filtering. description_l10n Type: string Summary of the contents in this package. justification_l10n Type: string Explanation of why this software release is recommended for this cluster. software_package_type Type: enumerated value ("Disk_Firmware", "Hotfix", "Language_Pack", "Pre_Upgrade_HCI", "Software_Release") Software package type.
Installed The package has been successfully installed. Install_Failed Installing the package failed. Download_Failed Downloading the package failed. size Type: size (0 to 9223372036854775807 (8192.00P)) File size of the software package in bytes. is_reboot_required Type: boolean Whether a reboot is required during the upgrade process. release_version Type: string Version number of the software package. build_version [Added in 2.0.0.0] Type: string Build number of the software package.
Unique identifier of this build. Was added in version 2.0.0.0. software_package_type_l10n Type: string Localized message string corresponding to software_package_type. software_package_state_l10n Type: string Localized message string corresponding to software_package_state. build_flavor_l10n [Added in 2.0.0.0] Type: string Localized message string corresponding to build_flavor Was added in version 2.0.0.0. build_type_l10n [Added in 2.0.0.
Attribute Select Sort Search justification_l10n X X X name X X X release_timestamp X X X release_version X X X size X X X software_package_state X X X software_package_state_l10n X X X software_package_type X X X software_package_type_l10n X X X Format software_package [ { -id | -name } ] show [ -select ,… ] [ -sort [+|-],… ] [ -offset ] [ { -limit | -all } ] [ -query ] [ -output { nvp | csv [ -table ] [ -nofo
-limit Limits the number of listed records. -all Query all records. -query Query records that fulfill the specified condition. -output Change the output format. nvp Display output as plain text. csv Display output in CSV format. table Display output in a table. json Display output in JSON format. create Push a software package file from the client to the cluster. When successfully uploaded and verified, the result is a software_package in the downloaded state, ready to install.
-id Unique identifier of the software package to delete. -name Unique name of the existing object (software_package). -async Perform asynchronous operation. install Start a software upgrade background job for the specified appliance within the cluster. If an appliance is not specified, the upgrade is performed on all appliances in the cluster. Only specify a subset of appliances to upgrade if the time required to upgrade the entire cluster does not fit within a desired maintenance window.
Format software_package { -id | -name } puhc [ -async ] Action qualifiers -id Unique identifier of the software package. -name Unique name of the existing object (software_package). -async Perform asynchronous operation. x509_certificate Use this resource type to manage SSL/TLS certificates. The X509 Certificate service is part of the credential store services.
VASA HTTP VASA provider service Import HTTP External web service Values was added in 1.0.3: LDAP_HTTP, Syslog_HTTP. is_current Indicates whether this is the current X509 Certificate to be used by the service or this X509 Certificate will be used in the future. When is_current is false for a X509 Certificate, this X509 Certificate will not be picked up by the service. Potential usage of this attribute is to prepare for the certificate roll-over/rotation.
subject_alternative_names Additional DNS names or IP addresses in the x509_certificate. public_key_algorithm Public key algorithm used to generate the key pair. key_length Private key length. thumbprint_algorithm The thumbprint algorithm: SHA-256 SHA-256 algorithm thumbprint Hash value of the certificate. certificate Base64 encoded certificate without any line breaks. depth Depth indicates the position of this member certificate in the X509 Certificate chain.
Attribute Select type X type_l10n X Sort Search Format x509_certificate [ -id ] show [ -select ,… ] [ -output { nvp | csv [ -table ] [ -noformat ] | table | json [ -raw ] } ] Action qualifiers -id Unique identifier of the X509 Certificate. -select Display selected attributes in the output. -output Change the output format. nvp Display output as plain text. csv Display output in CSV format. table Display output in a table. json Display output in JSON format. [Added in 2.0.0.
Server Server Certificate Client Client Certificate CA Client Validation A CA certificate used to authenticate clients during an SSL handshake. CA Server Validation A CA certificate used to verify the server during an SSL handshake. -service Type of the service for which the certificate is used: Management HTTP Management Web server Replication HTTP Remote Replication service VASA HTTP VASA provider service Import HTTP External web service Values was added in 1.0.3: LDAP_HTTP, Syslog_HTTP.
-passphrase Passphrase used to encrypt private key. -passphraseSecure Secure version of -passphrase. Value will be queried interactively. -is_current Indicates whether this is the current X509 certificate to be used by the service or this X509 Certificate will be used in the future. When is_current is false for a X509 Certificate, this X509 Certificate will not be picked up by the service. Potential usage of this attribute is to prepare for the certificate roll-over/rotation.
Format x509_certificate csr -type { Server | Client | CA_Client_Validation | CA_Server_Validation } -service { Management_HTTP | Replication_HTTP | VASA_HTTP | Import_HTTP | LDAP_HTTP | Syslog_HTTP } -dns_name ,… -ip_addresses ,… -key_length <2048..
use scope to indicate the origin of these certificates.
Management HTTP Management Web server Replication HTTP Remote Replication service VASA HTTP VASA provider service Import HTTP External web service Values was added in 1.0.3: LDAP_HTTP, Syslog_HTTP. -address Peer’s ip v4 or v6 address or dns name. -port Peer’s port number. -username Username used in basic authentication to remote PowerStore cluster. -password Password used in basic authentication to remote PowerStore cluster. -passwordSecure Secure version of -password.
Management HTTP Management Web server Replication HTTP Remote Replication service VASA HTTP VASA provider service Import HTTP External web service Values was added in 1.0.3: LDAP_HTTP, Syslog_HTTP. -async Perform asynchronous operation. Storage Storage configuration of the system: • Create delete storage resources • Configure NAS servers file_dns Use these resources to configure the Domain Name System (DNS) settings for a NAS server. One DNS settings object may be configured per NAS server.
ip_addresses Type: array of strings The list of DNS server IP addresses. The addresses may be IPv4 or IPv6. transport Type: enumerated value ("TCP", "UDP") Transport used when connecting to the DNS Server: UDP DNS uses the UDP protocol (default) TCP DNS uses the TCP protocol. transport_l10n Type: string Localized message string corresponding to transport. nas_server This is the embeddable reference form of nas_server_id attribute.
Attribute Select Sort Search nas_server.current_unix_directory_service_l10n X nas_server.default_unix_user X nas_server.default_windows_user X nas_server.description X nas_server.id X nas_server.is_auto_user_mapping_enabled X nas_server.is_username_translation_enabled X nas_server.name X nas_server.operational_status X nas_server.operational_status_l10n X nas_server.preferred_node_id X nas_server.production_IPv4_interface_id X nas_server.
-sort Sorts output field+ (or just field) sort by field in ascending order. field- sort by field in descending order. -offset Start record list starting from specific value. -limit Limits the number of listed records. -all Query all records. -query Query records that fulfill the specified condition. -output Change the output format. nvp Display output as plain text. csv Display output in CSV format. table Display output in a table. json Display output in JSON format.
-domain Name of the DNS domain, where the NAS Server does host names lookup when an FQDN is not specified in the request. -ip_addresses The list of DNS server IP addresses. The addresses may be IPv4 or IPv6. -transport Transport used when connecting to the DNS Server: UDP DNS uses the UDP protocol (default) TCP DNS uses the TCP protocol -async Perform asynchronous operation. delete Delete DNS settings of a NAS Server.
not specified in the request. -ip_addresses A new list of DNS server IP addresses to replace the existing list. The addresses may be IPv4 or IPv6. -add_ip_addresses IP addresses to add to the current list. The addresses may be IPv4 or IPv6. Error occurs if an IP address already exists. Cannot be combined with ip_addresses. -remove_ip_addresses IP addresses to remove from the current list. The addresses may be IPv4 or IPv6. Error occurs if IP address is not present. Cannot be combined with ip_addresses.
nas_server_id Type: string Unique identifier of the NAS server that is configured with the FTP server. is_ftp_enabled Type: boolean Indicates whether the FTP server is enabled on the NAS server. Values are: - true - FTP server is enabled on the specified NAS server. - false - FTP server is disabled on the specified NAS server. is_sftp_enabled Type: boolean Indicates whether the SFTP server is enabled on the NAS server. Values are: - true - SFTP server is enabled on the specified NAS server.
default_homedir Type: string (Applies when the value of is_homedir_limit_enabled is false.) Default directory of FTP and SFTP clients that have a home directory which is not defined or accessible. welcome_message Type: string Welcome message displayed on the console of FTP and SFTP clients before their authentication. The length of this message is limited to 511 bytes of UTF-8 characters, and the length of each line is limited to 80 bytes.
SFTP. - If denied hosts exist, they always have access denied to the NAS server through FTP or SFTP. - If the list is empty, there is no restriction to NAS server access through FTP or SFTP based on the host IP address. - The addresses may be IPv4 or IPv6. users Type: array of strings Allowed or denied users, depending on the value of the is_allowed_users attribute. - If allowed users exist, only those users and no others can connect to the NAS server through FTP or SFTP.
Attribute Select Sort Search audit_dir X X X audit_max_size X X X default_homedir X X X groups X X X hosts X X X id X X X is_allowed_groups X X X is_allowed_hosts X X X is_allowed_users X X X is_anonymous_authentication_enabled X X X is_audit_enabled X X X is_ftp_enabled X X X is_homedir_limit_enabled X X X is_sftp_enabled X X X is_smb_authentication_enabled X X X is_unix_authentication_enabled X X X message_of_the_day X X X nas_server.
Attribute Select Sort Search nas_server.current_preferred_IPv6_interface_id X nas_server.current_unix_directory_service X nas_server.current_unix_directory_service_l10n X nas_server.default_unix_user X nas_server.default_windows_user X nas_server.description X nas_server.id X nas_server.is_auto_user_mapping_enabled X nas_server.is_username_translation_enabled X nas_server.name X nas_server.operational_status X nas_server.operational_status_l10n X nas_server.
-id Unique identifier of the FTP/SFTP Server object. -select Display selected attributes in the output. -sort Sorts output field+ (or just field) sort by field in ascending order. field- sort by field in descending order. -offset Start record list starting from specific value. -limit Limits the number of listed records. -all Query all records. -query Query records that fulfill the specified condition. -output Change the output format. nvp Display output as plain text.
-message_of_the_day ] [ -is_audit_enabled { yes | true | no | false } ] [ -audit_dir ] [ -audit_max_size <40960 (40.00K) .. 5368709120 (5.00G)> ] [ -hosts ,… ] [ -users ,… ] [ -groups ,… ] [ -is_allowed_hosts { yes | true | no | false } ] [ -is_allowed_users { yes | true | no | false } ] [ -is_allowed_groups { yes | true | no | false } ] [ -async ] Action qualifiers -nas_server_id Unique identifier of the NAS server that is configured with the FTP server.
length of each line is limited to 80 bytes. -message_of_the_day Message of the day displayed on the console of FTP clients after their authentication. The length of this message is limited to 511 bytes of UTF-8 characters, and the length of each line is limited to 80 bytes. -is_audit_enabled Indicates whether the activity of FTP and SFTP clients is tracked in audit files. Values are: true - FTP/SFTP activity is tracked. - false - FTP/SFTP activity is not tracked.
-is_allowed_hosts Indicates whether the hosts attribute contains allowed or denied hosts. Values are: - true Hosts contains allowed hosts. - false - Hosts contains denied hosts. -is_allowed_users Indicates whether the users attribute contains allowed or denied users. Values are: - true Users contains allowed users. - false - Users contains denied users. -is_allowed_groups Indicates whether the groups attribute contains allowed or denied user groups. Values are: true - Groups contains allowed user groups.
-id Unique identifier of the FTP/SFTP Server object. -is_ftp_enabled Indicates whether the FTP server is enabled on the NAS server specified in the nasServer attribute. Values are: - true - FTP server is enabled on the specified NAS server. - false - FTP server is disabled on the specified NAS server. -is_sftp_enabled Indicates whether the SFTP server is enabled on the NAS server specified in the nasServer attribute. Values are: - true - SFTP server is enabled on the specified NAS server.
-is_audit_enabled Indicates whether the activity of FTP and SFTP clients is tracked in audit files. Values are: true - FTP/SFTP activity is tracked. - false - FTP/SFTP activity is not tracked. -audit_dir (Applies when the value of is_audit_enabled is true.) Directory of FTP/SFTP audit files. Logs are saved in '/' directory (default) or in a mounted file system (Absolute path of the File system directory which should already exist). -audit_max_size (Applies when the value of is_audit_enabled is true.
-groups Allowed or denied user groups, depending on the value of the is_allowed_groups attribute. If allowed groups exist, only users who are members of these groups and no others can connect to the NAS server through FTP or SFTP. - If denied groups exist, all users who are members of those groups always have access denied to the NAS server through FTP or SFTP. If the list is empty, there is no restriction to the NAS server access through FTP or SFTP based on the user group.
ip_address Type: string IP address of the network interface. IPv4 and IPv6 are supported. prefix_length Type: 32-bit signed integer (0 to 2147483647) Prefix length for the interface. IPv4 and IPv6 are supported. gateway Type: string Gateway address for the network interface. IPv4 and IPv6 are supported. vlan_id Type: 32-bit signed integer (0 to 4094) Virtual Local Area Network (VLAN) identifier for the interface. The interface uses the identifier to accept packets that have matching VLAN tags.
file_interface_routes This is the inverse of the resource type file_interface_route association. See file_interface_route for more details show Property capabilities Attribute Select Sort Search file_interface_routes.destination X file_interface_routes.file_interface_id X file_interface_routes.gateway X file_interface_routes.id X file_interface_routes.operational_status X file_interface_routes.operational_status_l10n X file_interface_routes.
Attribute Select Sort Search nas_server.current_unix_directory_service_l10n X nas_server.default_unix_user X nas_server.default_windows_user X nas_server.description X nas_server.id X nas_server.is_auto_user_mapping_enabled X nas_server.is_username_translation_enabled X nas_server.name X nas_server.operational_status X nas_server.operational_status_l10n X nas_server.preferred_node_id X nas_server.production_IPv4_interface_id X nas_server.
-id Unique identifier of the file interface. -name Unique name of the existing object (file_interface). -select Display selected attributes in the output. -sort Sorts output field+ (or just field) sort by field in ascending order. field- sort by field in descending order. -offset Start record list starting from specific value. -limit Limits the number of listed records. -all Query all records. -query Query records that fulfill the specified condition. -output Change the output format.
yes | true | no | false } ] [ -async ] Action qualifiers -nas_server_id Unique identifier of the NAS server to which the network interface belongs, as defined by the nas_server resource type. -ip_address IP address of the network interface. IPv4 and IPv6 are supported. -prefix_length Prefix length for the interface. IPv4 and IPv6 are supported. -gateway Gateway address for the network interface. IPv4 and IPv6 are supported. -vlan_id Virtual Local Area Network (VLAN) identifier for the interface.
-async Perform asynchronous operation. set Modify the settings of a file interface. Format file_interface { -id | -name } set [ -ip_address ] [ -prefix_length <1..128> ] [ -gateway ] [ -vlan_id <0..4094> ] [ -is_disabled { yes | true | no | false } ] [ -async ] Action qualifiers -id Unique identifier of the file interface. -name Unique name of the existing object (file_interface). -ip_address IP address of the network interface. IPv4 and IPv6 are supported.
Note: IP routes connect an interface (IP address) to the larger network through gateways. Without routes and gateway specified, the interface is no longer accessible outside of its immediate subnet. As a result, network shares and exports associated with the interface are no longer available to clients outside their immediate subnet. Properties of the file interface route.
Invalid_IP_Version Source interfaces have a different IP protocol version than the route. Invalid_Source_Interface No source interfaces set up on the system. Invalid_Gateway Source interfaces in a different subnet than the gateway. Not_Operational The route is not operational. operational_status_l10n Type: string Localized message string corresponding to operational_status. file_interface This is the embeddable reference form of file_interface_id attribute.
Attribute Select Sort Search file_interface_id X X X gateway X X X id X X X operational_status X X X operational_status_l10n X X X prefix_length X X X Format file_interface_route [ -id ] show [ -select ,… ] [ -sort [+|-],… ] [ -offset ] [ { -limit | -all } ] [ -query ] [ -output { nvp | csv [ -table ] [ -noformat ] | table | json [ -raw ] } ] Action qualifiers -id Unique identifier of the file interface route object.
-output Change the output format. nvp Display output as plain text. csv Display output in CSV format. table Display output in a table. json Display output in JSON format. create Create and configure a new file interface route. There are three types of routes - Subnet, Default, and Host. • A default route establishes a static route to a default gateway. To create a default route, specify gateway value for the related file interface. • A host route establishes a static route to a specific host.
-gateway IP address of the gateway associated with the route. -async Perform asynchronous operation. delete Delete file interface route. Format file_interface_route -id delete [ -async ] Action qualifiers -id Unique identifier of the file interface route object. -async Perform asynchronous operation. set Modify file interface route settings. Format file_interface_route -id set -destination -prefix_length <1..
-gateway IP address of the gateway associated with the route. -async Perform asynchronous operation. file_kerberos Use these resources to manage the Kerberos service for a NAS server. One Kerberos service object may be configured per NAS Server. Kerberos is a distributed authentication service designed to provide strong authentication with secret-key cryptography. It works on the basis of "tickets" that allow nodes communicating over a non-secure network to prove their identity in a secure manner.
details show Property capabilities Attribute Select Sort Search id X X X kdc_addresses X X X nas_server.backup_IPv4_interface_id X nas_server.backup_IPv6_interface_id X nas_server.current_node_id X nas_server.current_preferred_IPv4_interface_id X nas_server.current_preferred_IPv6_interface_id X nas_server.current_unix_directory_service X nas_server.current_unix_directory_service_l10n X nas_server.default_unix_user X nas_server.default_windows_user X nas_server.
Attribute Select Sort Search nas_server.production_IPv4_interface_id X nas_server.production_IPv6_interface_id X nas_server_id X X X port_number X X X realm X X X Format file_kerberos [ -id ] show [ -select ,… ] [ -sort [+|-],… ] [ -offset ] [ { -limit | -all } ] [ -query ] [ -output { nvp | csv [ -table ] [ -noformat ] | table | json [ -raw ] } ] Action qualifiers -id Kerberos service object.
nvp Display output as plain text. csv Display output in CSV format. table Display output in a table. json Display output in JSON format. create Create a Kerberos configuration. The operation will fail if a Kerberos configuration already exists. Format file_kerberos create -nas_server_id -port_number <0..65535> ] [ -async ] -realm -kdc_addresses ,… [ Action qualifiers -nas_server_id Unique identifier of the associated NAS Server instance that uses this Kerberos object.
-async Perform asynchronous operation. set Modify the Kerberos service settings of a NAS Server. Format file_kerberos -id set [ -realm ] [ -kdc_addresses ,… ] [ -add_kdc_addresses ,… ] [ -remove_kdc_addresses ,… ] [ -port_number <0..65535> ] [ -async ] Action qualifiers -id Unique identifier of the Kerberos service object. -realm Realm name of the Kerberos Service. -kdc_addresses Fully Qualified domain names of the Kerberos Key Distribution Center (KDC) servers.
Action qualifiers -id Unique identifier of the Kerberos service object. -async Perform asynchronous operation. download_keytab Download previously uploaded keytab file for secure NFS service. Format file_kerberos [ { -f | -d } ] -id download_keytab Action qualifiers -f Local path with the file name -d Local folder where file shall be stored -id Unique identifier of the Kerberos service object.
LDAP object per NAS Server is supported. base_DN Type: string Name of the LDAP base DN. Base Distinguished Name (BDN) of the root of the LDAP directory tree. The appliance uses the DN to bind to the LDAP service and locate in the LDAP directory tree to begin a search for information. The base DN can be expressed as a fully-qualified domain name or in X.509 format by using the attribute dc=. For example, if the fullyqualified domain name is mycompany.
LDAP LDAP protocol without SSL. LDAPS (Default) LDAP protocol with SSL. When you enable LDAPS, make sure to specify the appropriate LDAPS port (usually port 636) and to upload an LDAPS trust certificate to the LDAP server. is_verify_server_certificate Type: boolean Indicates whether a Certification Authority certificate is used to verify the LDAP server certificate for secure SSL connections. Values are: true verifies LDAP server’s certificate. false doesn’t verify LDAP server’s certificate.
Microsoft Microsoft Identity Management for UNIX (IDMU/SFU) schema. Unknown Unknown protocol. is_config_file_uploaded Type: boolean Indicates whether an LDAP configuration file has been uploaded. is_certificate_uploaded Type: boolean Indicates whether an LDAP certificate file has been uploaded. authentication_type_l10n Type: string Localized message string corresponding to authentication_type. protocol_l10n Type: string Localized message string corresponding to protocol.
Attribute Select Sort Search id X X X is_certificate_uploaded X X X is_config_file_uploaded X X X is_smb_account_used X X X is_verify_server_certificate X X X nas_server.backup_IPv4_interface_id X nas_server.backup_IPv6_interface_id X nas_server.current_node_id X nas_server.current_preferred_IPv4_interface_id X nas_server.current_preferred_IPv6_interface_id X nas_server.current_unix_directory_service X nas_server.current_unix_directory_service_l10n X nas_server.
Attribute Select Sort Search nas_server.preferred_node_id X nas_server.production_IPv4_interface_id X nas_server.
-offset Start record list starting from specific value. -limit Limits the number of listed records. -all Query all records. -query Query records that fulfill the specified condition. -output Change the output format. nvp Display output as plain text. csv Display output in CSV format. table Display output in a table. json Display output in JSON format. create Create an LDAP service on a NAS Server. Only one LDAP Service object can be created per NAS Server.
Anonymous Anonymous authentication means no authentication occurs and the NAS Server uses an anonymous login to access the LDAP-based directory server. Simple Simple authentication means the NAS Server must provide a bind distinguished name and password to access the LDAP-based directory server. Kerberos Kerberos authentication means the NAS Server uses a KDC to confirm the identity when accessing the Active Directory. -base_DN Name of the LDAP base DN.
-profile_DN For an iPlanet LDAP server, specifies the DN of the entry with the configuration profile. -bind_DN Bind Distinguished Name (DN) to be used when binding. -bind_password The associated password to be used when binding to the server. -bind_passwordSecure Secure version of -bind_password. Value will be queried interactively. -is_smb_account_used Indicates whether SMB authentication is used to authenticate to the LDAP server.
-async Perform asynchronous operation. set Modify a NAS Server’s LDAP settings object. Format file_ldap -id set [ -authentication_type { Anonymous | Simple | Kerberos } ] [ -base_DN ] [ -addresses ,… ] [ -add_addresses ,… ] [ -remove_addresses ,… ] [ -port_number <0..
IPv6. Error occurs if an IP address already exists in the addresses list. Cannot be combined with addresses. -remove_addresses IP addresses to remove from the current server IP addresses list. The addresses may be IPv4 or IPv6. Error occurs if an IP address does not exist in the addresses_list. Cannot be combined with addresses. -port_number The TCP/IP port used by the NAS Server to connect to the LDAP servers. -protocol Indicates whether the LDAP protocol uses SSL for secure network communication.
false Indicates that Kerberos uses its own settings. -principal Specifies the principal name for Kerberos authentication. -realm Specifies the realm name for Kerberos authentication. -password The associated password for Kerberos authentication. -passwordSecure Secure version of -password. Value will be queried interactively. -async Perform asynchronous operation.
Format file_ldap [ { -f | -d } ] -id download_certificate Action qualifiers -f Local path with the file name -d Local folder where file shall be stored -id Unique identifier of the LDAP settings object. download_config Format file_ldap [ { -f | -d } ] -id download_config Action qualifiers -f Local path with the file name -d Local folder where file shall be stored -id Unique identifier of the LDAP settings object.
nas_server_id Type: string Unique identifier of the NAS server to be configured with these NDMP settings. user_name Type: string User name for accessing the NDMP service. nas_server This is the embeddable reference form of nas_server_id attribute. See nas_server for more details show Property capabilities Attribute Select Sort Search id X X X nas_server.backup_IPv4_interface_id X nas_server.backup_IPv6_interface_id X nas_server.current_node_id X nas_server.
Attribute Select Sort Search nas_server.is_username_translation_enabled X nas_server.name X nas_server.operational_status X nas_server.operational_status_l10n X nas_server.preferred_node_id X nas_server.production_IPv4_interface_id X nas_server.
-all Query all records. -query Query records that fulfill the specified condition. -output Change the output format. nvp Display output as plain text. csv Display output in CSV format. table Display output in a table. json Display output in JSON format. create Add an NDMP service configuration to a NAS server. Only one NDMP service object can be configured per NAS server.
Format file_ndmp -id delete [ -async ] Action qualifiers -id Unique identifier of the NDMP service object. -async Perform asynchronous operation. set Modify an NDMP service configuration instance. Format file_ndmp -id set [ -user_name ] [ { -password | -passwordSecure } ] [ -async ] Action qualifiers -id Unique identifier of the NDMP service object. -user_name User name for accessing the NDMP service. -password Password for the NDMP service user.
Unique identifier of the NIS Service. nas_server_id Type: string Unique identifier of the associated NAS Server instance that uses this NIS Service object. Only one NIS Service per NAS Server is supported. domain Type: string Name of the NIS domain. ip_addresses Type: array of strings The list of NIS server IP addresses. nas_server This is the embeddable reference form of nas_server_id attribute.
Attribute Select nas_server.default_unix_user X nas_server.default_windows_user X nas_server.description X nas_server.id X nas_server.is_auto_user_mapping_enabled X nas_server.is_username_translation_enabled X nas_server.name X nas_server.operational_status X nas_server.operational_status_l10n X nas_server.preferred_node_id X nas_server.production_IPv4_interface_id X nas_server.
field- sort by field in descending order. -offset Start record list starting from specific value. -limit Limits the number of listed records. -all Query all records. -query Query records that fulfill the specified condition. -output Change the output format. nvp Display output as plain text. csv Display output in CSV format. table Display output in a table. json Display output in JSON format. create Create a new NIS Service on a NAS Server.
-async Perform asynchronous operation. delete Delete NIS settings of a NAS Server. Format file_nis -id delete [ -async ] Action qualifiers -id Unique identifier of the NIS object. -async Perform asynchronous operation. set Modify the NIS settings of a NAS Server. Format file_nis -id set [ -domain ] [ -ip_addresses ,… ] [ -add_ip_addresses ,… ] [ -remove_ip_addresses ,… ] [ -async ] Action qualifiers -id Unique identifier of the NIS object.
file_system Use this resource type to manage NAS file systems. Properties of a file system. This resource type has queriable associations from nas_server, policy, file_tree_quota, file_user_quota, nfs_export, smb_share Attributes id Type: string Unique identifier of the file system. name Type: string Name of the file system. This property supports case-insensitive filtering. description Type: string Description of the file system.
size_used Type: size (0 to 9223372036854775807 (8192.00P)) Size used, in bytes, for the data and metadata of the file system. Value is always rounded up to next MB. protection_policy_id Type: string Unique identifier of the protection policy applied to the file system. access_policy Type: enumerated value ("Native", "UNIX", "Windows") File system security access policies. Each file system uses its access policy to determine how to reconcile the differences between NFS and SMB access control.
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. is_smb_sync_writes_enabled Type: boolean Indicates whether the synchronous writes option is enabled on the file system.
Indicates whether file writes notifications are enabled on the file system. Values are: true File writes notification are enabled on the file system. false File writes notifications are disabled on the file system. smb_notify_on_change_dir_depth Type: 32-bit signed integer (0 to 2147483647) Lowest directory level to which the enabled notifications apply, if any. is_async_MTime_enabled Type: boolean Indicates whether asynchronous MTIME is enabled on the file system.
can be used to compute the amount of space consumed without limiting the space). default_soft_limit Type: size (0 to 9223372036854775807 (8192.00P)) Default soft limit of user quotas and tree quotas (bytes). (0 means 'No limitation'). creation_timestamp Type: date time Time, in seconds, when the snapshot was created. expiration_timestamp Type: date time Time, in seconds, when the snapshot will expire. last_refresh_timestamp Type: date time Time, in seconds, when the snapshot was last refreshed.
creator_type Type: enumerated value ("Scheduler", "User") Enumeration of possible snapshot creator types. Scheduler Created by a snapshot schedule. User Created by a user. External_VSS Created by Windows Volume Shadow Copy Service (VSS) to obtain an application consistent snapshot. External_NDMP Created by an NDMP backup operation. External_Restore Created as a backup snapshot before a snapshot restore. External_Replication_Manager Created by Replication Manager.
creator_type_l10n Type: string Localized message string corresponding to creator_type. nas_server This is the embeddable reference form of nas_server_id attribute. See nas_server for more details protection_policy This is the embeddable reference form of protection_policy_id attribute. See policy for more details file_tree_quotas This is the inverse of the resource type file_tree_quota association.
Attribute Select Sort Search creator_type_l10n X X X default_hard_limit X X X default_soft_limit X X X description X X X expiration_timestamp X X X file_tree_quotas.description X file_tree_quotas.file_system_id X file_tree_quotas.grace_period X file_tree_quotas.hard_limit X file_tree_quotas.id X file_tree_quotas.is_user_quotas_enforced X file_tree_quotas.path X file_tree_quotas.remaining_grace_period X file_tree_quotas.size_used X file_tree_quotas.
Attribute Select Sort Search file_user_quotas.size_used X file_user_quotas.soft_limit X file_user_quotas.state X file_user_quotas.state_l10n X file_user_quotas.tree_quota_id X file_user_quotas.uid X file_user_quotas.unix_name X file_user_quotas.windows_name X file_user_quotas.
Attribute Select Sort Search is_smb_op_locks_enabled X X X is_smb_sync_writes_enabled X X X last_refresh_timestamp X X X last_writable_timestamp X X X locking_policy X X X locking_policy_l10n X X X name X X X nas_server.backup_IPv4_interface_id X nas_server.backup_IPv6_interface_id X nas_server.current_node_id X nas_server.current_preferred_IPv4_interface_id X nas_server.current_preferred_IPv6_interface_id X nas_server.current_unix_directory_service X nas_server.
Attribute Select nas_server.operational_status X nas_server.operational_status_l10n X nas_server.preferred_node_id X nas_server.production_IPv4_interface_id X nas_server.production_IPv6_interface_id X nas_server_id X nfs_exports.anonymous_GID X nfs_exports.anonymous_UID X nfs_exports.default_access X nfs_exports.default_access_l10n X nfs_exports.description X nfs_exports.file_system_id X nfs_exports.id X nfs_exports.is_no_SUID X nfs_exports.min_security X nfs_exports.
Attribute Select Sort Search nfs_exports.read_only_root_hosts X nfs_exports.read_write_hosts X nfs_exports.read_write_root_hosts X parent_id X X X protection_policy.description X protection_policy.id X protection_policy.is_replica X protection_policy.name X protection_policy.type X protection_policy.type_l10n X protection_policy_id X X X size_total X X X size_used X X X smb_notify_on_change_dir_depth X X X smb_shares.description X smb_shares.
Attribute Select smb_shares.name X smb_shares.offline_availability X smb_shares.offline_availability_l10n X smb_shares.path X smb_shares.umask X Sort Search Format file_system [ { -id | -name } ] show [ -select ,… ] [ -sort [+|-],… ] [ -offset ] [ { -limit | -all } ] [ -query ] [ -output { nvp | csv [ -table ] [ -noformat ] | table | json [ -raw ] } ] Action qualifiers -id Unique identifier of the file system.
-output Change the output format. nvp Display output as plain text. csv Display output in CSV format. table Display output in a table. json Display output in JSON format. create Create a file system. Format file_system create -name -size_total <3221225472 (3.00G) .. 281474976710656 (256.
UNIX UNIX Security. Windows Windows Security. -locking_policy File system locking policies. These policy choices control whether the NFSv4 range locks are honored. Because NFSv3 is advisory by design, this policy specifies that the NFSv4 locking feature behaves like NFSv3 (advisory mode), for backward compatiblity with applications expecting an advisory locking scheme. Advisory No lock checking for NFS and honor SMB lock range only for SMB. Mandatory Honor SMB and NFS lock range.
-is_smb_op_locks_enabled Indicates whether opportunistic file locking is enabled on the file system. Values are: true Opportunistic file locking is enabled on the file system. false Opportunistic file locking is disabled on the file system. -is_smb_notify_on_access_enabled Indicates whether file access notifications are enabled on the file system. Values are: true File access notifications are enabled on the file system. false File access notifications are disabled on the file system.
Action qualifiers -id Unique identifier of the file system. -name Unique name of the existing object (file_system). -async Perform asynchronous operation. set Modify a file system. Format file_system { -id | -name } set [ -description ] [ -size_total <3221225472 (3.00G) .. 281474976710656 (256.
UNIX UNIX Security. Windows Windows Security. -locking_policy File system locking policies. These policy choices control whether the NFSv4 range locks are honored. Because NFSv3 is advisory by design, this policy specifies that the NFSv4 locking feature behaves like NFSv3 (advisory mode), for backward compatiblity with applications expecting an advisory locking scheme. Advisory No lock checking for NFS and honor SMB lock range only for SMB. Mandatory Honor SMB and NFS lock range.
-is_smb_notify_on_access_enabled Indicates whether file access notifications are enabled on the file system. Values are: true File access notifications are enabled on the file system. false File access notifications on file access are disabled on the file system. -is_smb_notify_on_write_enabled Indicates whether notifications on file writes are enabled on the file system. Values are: true File writes notifications are enabled on the file system.
false Stop tracking usages for all users on a file system or a quota tree, and user quota limits will not be enforced. -grace_period Grace period of soft limits (seconds): -1: default Infinite grace (Windows policy). 0 Use system default of 1 week. Positive Grace period after which the soft limit is treated as a hard limit (seconds). -default_hard_limit Default hard limit of user quotas and tree quotas (bytes). The hard limit value is always rounded up to match the file system’s physical block size.
-name Unique name of the existing object (file_system). -name Name of the clone. -description Description of the clone. -access_policy File system security access policies. Each file system uses its access policy to determine how to reconcile the differences between NFS and SMB access control. Selecting an access policy determines which mechanism is used to enforce file security on the particular file system. Native Native Security. UNIX UNIX Security. Windows Windows Security.
-is_smb_sync_writes_enabled Indicates whether the synchronous writes option is enabled on the file system. Values are: true Synchronous writes option is enabled on the file system. false Synchronous writes option is disabled on the file system. -is_smb_no_notify_enabled Indicates whether notifications of changes to directory file structure are enabled. true Change directory notifications are disabled. false Change directory notifications are enabled.
false Asynchronous MTIME is disabled on the file system. -async Perform asynchronous operation. refresh Refresh a snapshot of a file system. The content of the snapshot is replaced with the current content of the parent file system. Format file_system { -id | -name } refresh [ -async ] Action qualifiers -id Unique identifier of the file system snapshot. -name Unique name of the existing object (file_system). -async Perform asynchronous operation.
200 Success with backup snapshot. 204 Success without backup snapshot. Format file_system { -id | -name } restore [ -copy_name ] [ -async ] Action qualifiers -id Unique identifier of the file system snapshot. -name Unique name of the existing object (file_system). -copy_name Name of the backup snap to be created before the Restore operation occurs. If no name is specified no backup copy will be made. -async Perform asynchronous operation.
-description Description of the snapshot. -expiration_timestamp Time, when the snapshot will expire. -is_auto_delete_enabled Indicates whether the snapshot can be automatically deleted per threshold settings. Values are: true Snapshot can be automatically deleted per threshold settings. false Snapshot cannot be automatically deleted. -access_type Indicates whether the snapshot directory or protocol access is granted to the file system snapshot. ◦ Snapshot- Snapshot access is via the .
-folder_rename_policy File system folder rename policies for the file system with multiprotocol access enabled. These policies control whether the directory can be renamed from NFS or SMB clients when at least one file is opened in the directory, or in one of its child directories. All_Allowed All protocols are allowed to rename directories without any restrictions.
-is_smb_notify_on_write_enabled Indicates whether file writes notifications are enabled on the file system. Values are: true File writes notifications are enabled on the file system. false File writes notifications are disabled on the file system. -smb_notify_on_change_dir_depth Lowest directory level to which the enabled notifications apply, if any. -is_async_MTime_enabled Indicates whether asynchronous MTIME is enabled on the protocol snaps that are mounted writeable.
Description of the tree quota. is_user_quotas_enforced Type: boolean Whether user quota are enabled on this tree quota. The tree quota itself is enforced regardless of this parameter. state Type: enumerated value ("Hard_Reached", "Ok", "Soft_Exceeded", "Soft_Exceeded_And_Expired") State of the user quota or tree quota record period. OK No quota limits are exceeded. Soft_Exceeded Soft limit is exceeded, and grace period is not expired.
grace_period [Added in 2.0.0.0] Type: 32-bit signed integer (-1 to 2147483647) Grace period of soft limit (seconds). This will override the default grace period set at filesystem level. -1 Infinite grace period (Windows policy). 0 Use default grace period of 1 week (default). Positive Grace period after which the soft limit is treated as a hard limit (seconds). Was added in version 2.0.0.0. state_l10n Type: string Localized message string corresponding to state.
Attribute Select file_system.creator_type_l10n X file_system.default_hard_limit X file_system.default_soft_limit X file_system.description X file_system.expiration_timestamp X file_system.filesystem_type X file_system.filesystem_type_l10n X file_system.folder_rename_policy X file_system.folder_rename_policy_l10n X file_system.grace_period X file_system.id X file_system.is_async_MTime_enabled X file_system.is_modified X file_system.is_quota_enabled X file_system.
Attribute Select file_system.locking_policy X file_system.locking_policy_l10n X file_system.name X file_system.nas_server_id X file_system.parent_id X file_system.protection_policy_id X file_system.size_total X file_system.size_used X file_system.smb_notify_on_change_dir_depth X file_system_id X file_user_tree_quotas.file_system_id X file_user_tree_quotas.hard_limit X file_user_tree_quotas.id X file_user_tree_quotas.remaining_grace_period X file_user_tree_quotas.
Attribute Select Sort Search file_user_tree_quotas.windows_name X file_user_tree_quotas.
-offset Start record list starting from specific value. -limit Limits the number of listed records. -all Query all records. -query Query records that fulfill the specified condition. -output Change the output format. nvp Display output as plain text. csv Display output in CSV format. table Display output in a table. json Display output in JSON format. create Create a tree quota instance. Format file_tree_quota create -file_system_id -path [ -description ] [ -hard_limit <0 ..
rounded up to match the physical block size of the filesystem. -soft_limit Soft limit of the tree quota, in bytes. No hard limit when set to 0. Value is always rounded up to match the physical block size of the filesystem. -is_user_quotas_enforced Whether the quota must be enabled for all users, and whether user quota limits, if any, are enforced. Values are: true Start tracking usage for all users on the quota tree, and enforce user quota limits.
set Modify a tree quota instance. Format file_tree_quota -id set [ -description ] [ -hard_limit <0 .. 9223372036854775807 (8192.00P)> ] [ -soft_limit <0 .. 9223372036854775807 (8192.00P)> ] [ -is_user_quotas_enforced { yes | true | no | false } ] [ -grace_period[Added in 2.0.0.0] ] [ -async ] Action qualifiers -id Unique identifier of the tree quota. -description Description of the tree quota. -hard_limit Hard limit of the tree quota, in bytes. No hard limit when set to 0.
-async Perform asynchronous operation. refresh Refresh the cache with the actual value of the tree quota. Format file_tree_quota -id refresh [ -async ] Action qualifiers -id Unique identifier of the tree quota. -async Perform asynchronous operation. file_user_quota User quota settings in the storage system. A user quota instance represents a quota limit applied to a user within a quota tree or a filesystem.
Unix username. windows_name Type: string Windows username. The format is domain\\user for the domain user. windows_sid Type: string Windows Security Identifier of the user. state Type: enumerated value ("Hard_Reached", "Ok", "Soft_Exceeded", "Soft_Exceeded_And_Expired") State of the user quota or tree quota record period. OK No quota limits are exceeded. Soft_Exceeded Soft limit is exceeded, and grace period is not expired.
state_l10n Type: string Localized message string corresponding to state. file_system This is the embeddable reference form of file_system_id attribute. See file_system for more details tree_quota This is the embeddable reference form of tree_quota_id attribute. See file_tree_quota for more details show Property capabilities Attribute Select file_system.access_policy X file_system.access_policy_l10n X file_system.access_type X file_system.access_type_l10n X file_system.
Attribute Select file_system.folder_rename_policy_l10n X file_system.grace_period X file_system.id X file_system.is_async_MTime_enabled X file_system.is_modified X file_system.is_quota_enabled X file_system.is_smb_no_notify_enabled X file_system.is_smb_notify_on_access_enabled X file_system.is_smb_notify_on_write_enabled X file_system.is_smb_op_locks_enabled X file_system.is_smb_sync_writes_enabled X file_system.last_refresh_timestamp X file_system.
Attribute Select Sort Search file_system.smb_notify_on_change_dir_depth X file_system_id X X X hard_limit X X X id X X X remaining_grace_period X X X size_used X X X soft_limit X X X state X X X state_l10n X X X tree_quota.description X tree_quota.file_system_id X tree_quota.grace_period X tree_quota.hard_limit X tree_quota.id X tree_quota.is_user_quotas_enforced X tree_quota.path X tree_quota.remaining_grace_period X tree_quota.size_used X tree_quota.
Attribute Select Sort Search tree_quota_id X X X uid X X X unix_name X X X windows_name X X X windows_sid X X X Format file_user_quota [ -id ] show [ -select ,… ] [ -sort [+|-],… ] [ -offset ] [ { -limit | -all } ] [ -query ] [ -output { nvp | csv [ -table ] [ -noformat ] | table | json [ -raw ] } ] Action qualifiers -id Unique identifier of the file user quota. -select Display selected attributes in the output.
nvp Display output as plain text. csv Display output in CSV format. table Display output in a table. json Display output in JSON format. create Create a user quota instance. Format file_user_quota create -file_system_id [ -tree_quota_id ] [ -uid <1..4294967294> ] [ -unix_name ] [ -windows_name ] [ -windows_sid ] [ -hard_limit <0 .. 9223372036854775807 (8192.00P)> ] [ -soft_limit <0 .. 9223372036854775807 (8192.
-soft_limit Soft limit of the user quota, in bytes. No hard limit when set to 0. Value is rounded up to match the physical block size of the filesystem. -async Perform asynchronous operation. set Modify a user quota instance. Format file_user_quota -id set [ -hard_limit <0 .. 9223372036854775807 (8192.00P)> ] [ -soft_limit <0 .. 9223372036854775807 (8192.00P)> ] [ -async ] Action qualifiers -id Unique identifier of the file user quota. -hard_limit Hard limit of the user quota, in bytes.
file_virus_checker Use these resource types to manage the virus checker service of a NAS server. A virus checker instance is created each time the anti-virus service is enabled on a NAS server. A configuration file (named viruschecker.conf) needs to be uploaded before enabling the anti-virus service. The cluster supports third-party anti-virus servers that perform virus scans and reports back to the storage system.
Attribute Select Sort Search id X X X is_config_file_uploaded X X X is_enabled X X X nas_server.backup_IPv4_interface_id X nas_server.backup_IPv6_interface_id X nas_server.current_node_id X nas_server.current_preferred_IPv4_interface_id X nas_server.current_preferred_IPv6_interface_id X nas_server.current_unix_directory_service X nas_server.current_unix_directory_service_l10n X nas_server.default_unix_user X nas_server.default_windows_user X nas_server.
Attribute Select nas_server.production_IPv6_interface_id X nas_server_id X Sort Search X X Format file_virus_checker [ -id ] show [ -select ,… ] [ -sort [+|-],… ] [ -offset ] [ { -limit | -all } ] [ -query ] [ -output { nvp | csv [ -table ] [ -noformat ] | table | json [ -raw ] } ] Action qualifiers -id Unique identifier of the virus checker instance. -select Display selected attributes in the output.
json Display output in JSON format. create Add a new virus checker setting to a NAS Server. Only one instance can be created per NAS Server. Workflow to enable the virus checker settings on the NAS Server is as follows: \n 1. Create a virus checker instance on NAS Server. 2. Download template virus checker configuration file. 3. Edit the configuration file with virus checker configuration details. 4. Upload the configuration file. 5. Enable the virus checker on the NAS Server.
Format file_virus_checker -id set -is_enabled { yes | true | no | false } [ -async ] Action qualifiers -id Unique identifier of the virus checker instance. -is_enabled Indicates whether the anti-virus service is enabled on this NAS server. Value are: - true Anti-virus service is enabled. Each file created or modified by an SMB client is scanned by the third-party anti-virus servers. If a virus is detected, the access to the file system is denied.
-d Local folder where file shall be stored -id Unique identifier of the virus checker instance. nas_server Use these resource types to manage NAS servers. NAS servers are software components used to transfer data and provide the connection ports for hosts to access file-based storage resources. NAS servers are independent from each other.
Degraded NAS server is degraded (running without backup). Unknown NAS server state is unknown. current_node_id Type: string Unique identifier of the node on which the NAS server is running. preferred_node_id Type: string Unique identifier of the preferred node for the NAS server The initial value (on NAS server creation) is taken from the current node. default_unix_user Type: string Default Unix user name used for granting access in case of Windows to Unix user mapping failure.
Unique identifier of the preferred IPv4 production interface. production_IPv6_interface_id Type: string Unique identifier of the preferred IPv6 production interface. backup_IPv4_interface_id Type: string Unique identifier of the preferred IPv4 backup interface. backup_IPv6_interface_id Type: string Unique identifier of the preferred IPv6 backup interface. current_preferred_IPv4_interface_id Type: string Unique identifier of the current active preferred IPv4 interface.
smb_servers This is the inverse of the resource type smb_server association. See smb_server for more details file_dnses This is the inverse of the resource type file_dns association. See file_dns for more details file_ftps This is the inverse of the resource type file_ftp association. See file_ftp for more details file_kerberoses This is the inverse of the resource type file_kerberos association. See file_kerberos for more details file_ldaps This is the inverse of the resource type file_ldap association.
Attribute Select Sort Search description X X X file_dnses.domain X file_dnses.id X file_dnses.ip_addresses X file_dnses.nas_server_id X file_dnses.transport X file_dnses.transport_l10n X file_ftps.audit_dir X file_ftps.audit_max_size X file_ftps.default_homedir X file_ftps.groups X file_ftps.hosts X file_ftps.id X file_ftps.is_allowed_groups X file_ftps.is_allowed_hosts X file_ftps.is_allowed_users X file_ftps.is_anonymous_authentication_enabled X file_ftps.
Attribute Select file_ftps.is_smb_authentication_enabled X file_ftps.is_unix_authentication_enabled X file_ftps.message_of_the_day X file_ftps.nas_server_id X file_ftps.users X file_ftps.welcome_message X file_interfaces.gateway X file_interfaces.id X file_interfaces.ip_address X file_interfaces.is_disabled X file_interfaces.name X file_interfaces.nas_server_id X file_interfaces.prefix_length X file_interfaces.role X file_interfaces.role_l10n X file_interfaces.
Attribute Select file_ldaps.addresses X file_ldaps.authentication_type X file_ldaps.authentication_type_l10n X file_ldaps.base_DN X file_ldaps.bind_DN X file_ldaps.id X file_ldaps.is_certificate_uploaded X file_ldaps.is_config_file_uploaded X file_ldaps.is_smb_account_used X file_ldaps.is_verify_server_certificate X file_ldaps.nas_server_id X file_ldaps.port_number X file_ldaps.principal X file_ldaps.profile_DN X file_ldaps.protocol X file_ldaps.protocol_l10n X file_ldaps.
Attribute Select file_ndmps.user_name X file_nises.domain X file_nises.id X file_nises.ip_addresses X file_nises.nas_server_id X file_systems.access_policy X file_systems.access_policy_l10n X file_systems.access_type X file_systems.access_type_l10n X file_systems.creation_timestamp X file_systems.creator_type X file_systems.creator_type_l10n X file_systems.default_hard_limit X file_systems.default_soft_limit X file_systems.description X file_systems.
Attribute Select file_systems.id X file_systems.is_async_MTime_enabled X file_systems.is_modified X file_systems.is_quota_enabled X file_systems.is_smb_no_notify_enabled X file_systems.is_smb_notify_on_access_enabled X file_systems.is_smb_notify_on_write_enabled X file_systems.is_smb_op_locks_enabled X file_systems.is_smb_sync_writes_enabled X file_systems.last_refresh_timestamp X file_systems.last_writable_timestamp X file_systems.locking_policy X file_systems.
Attribute Select Sort Search file_virus_checkers.is_config_file_uploaded X file_virus_checkers.is_enabled X file_virus_checkers.nas_server_id X id X X X is_auto_user_mapping_enabled X X X is_username_translation_enabled X X X name X X X nfs_servers.credentials_cache_TTL X nfs_servers.host_name X nfs_servers.id X nfs_servers.is_extended_credentials_enabled X nfs_servers.is_joined X nfs_servers.is_nfsv3_enabled X nfs_servers.is_nfsv4_enabled X nfs_servers.
Attribute Select Sort Search production_IPv4_interface_id X X X production_IPv6_interface_id X X X smb_servers.computer_name X smb_servers.description X smb_servers.domain X smb_servers.id X smb_servers.is_joined X smb_servers.is_standalone X smb_servers.nas_server_id X smb_servers.netbios_name X smb_servers.
field- sort by field in descending order. -offset Start record list starting from specific value. -limit Limits the number of listed records. -all Query all records. -query Query records that fulfill the specified condition. -output Change the output format. nvp Display output as plain text. csv Display output in CSV format. table Display output in a table. json Display output in JSON format. create Create a NAS server.
-default_unix_user 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 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. -is_username_translation_enabled Enable the possibility to match a Windows account with an Unix account with different names.
to an AD domain. -domain_password Administrator password used to unjoin the associated SMB servers from the Active Directory (AD) domain before deleting the NAS server. This parameter is required when the skipDomainUnjoin parameter is false or not set, and the NAS server has SMB servers joined to an AD domain. -domain_passwordSecure Secure version of -domain_password. Value will be queried interactively. -async Perform asynchronous operation. set Modify the settings of a NAS server.
-current_unix_directory_service 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 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 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.
-name Unique name of the existing object (nas_server). -destination_address Destination to ping, can be either an IP address (IPv4 or IPv6) or a hostname being resolved by the NAS server name resolvers. -is_ipv6 When true, and the destination is a hostname, it will be resolved to IPv6. Otherwise the hostname is resolved preferably to an IPv4 address. -async Perform asynchronous operation. update_user_mappings Fix the user mappings for all file systems associated with the NAS server.
Action qualifiers -f Local path with the file name -d Local folder where file shall be stored -id Unique identifier of the NAS server. -name Unique name of the existing object (nas_server). homedir Download a NAS server homedir file containing the template or the actual (if already uploaded) homedir configuration settings.
-d Local folder where file shall be stored -id Unique identifier of the NAS server. -name Unique name of the existing object (nas_server). netgroup Download an NAS server netgroup file containing the template or the actual (if already uploaded) netgroup details. Format nas_server/download [ { -f | -d } ] { -id | -name } netgroup Action qualifiers -f Local path with the file name -d Local folder where file shall be stored -id Unique identifier of the NAS server.
-id Unique identifier of the NAS server. -name Unique name of the existing object (nas_server). ntxmap Download an NAS server ntxmap file containing the template or the actual (if already uploaded) ntxmap configuration settings. Format nas_server/download [ { -f | -d } ] { -id | -name } ntxmap Action qualifiers -f Local path with the file name -d Local folder where file shall be stored -id Unique identifier of the NAS server.
-name Unique name of the existing object (nas_server). user_mapping_report Download the report generated by the update_user_mappings action. Format nas_server/download [ { -f | -d } ] { -id | -name } user_mapping_report Action qualifiers -f Local path with the file name -d Local folder where file shall be stored -id Unique identifier of the NAS server. -name Unique name of the existing object (nas_server). nas_server/upload group Upload NAS server group file.
homedir Upload the NAS server homedir file. Format nas_server/upload { -id | -name } homedir [ -body ] [ -async ] Action qualifiers -id Unique identifier of the NAS server. -name Unique name of the existing object (nas_server). -body Upload the NAS server homedir file. -async Perform asynchronous operation. hosts Upload NAS server host file.
Action qualifiers -id Unique identifier of the NAS server. -name Unique name of the existing object (nas_server). -body Upload the NAS server netgroup file. -async Perform asynchronous operation. nsswitch Upload the NAS server nsswitch file. Format nas_server/upload { -id | -name } nsswitch [ -body ] [ -async ] Action qualifiers -id Unique identifier of the NAS server. -name Unique name of the existing object (nas_server). -body Upload the NAS server nsswitch file.
-body Upload the NAS server ntxmap file. -async Perform asynchronous operation. passwd Upload NAS server passwd file. Format nas_server/upload { -id | -name } passwd [ -body ] [ -async ] Action qualifiers -id Unique identifier of the NAS server. -name Unique name of the existing object (nas_server). -body Upload NAS server passwd file. -async Perform asynchronous operation.
NFS Export name. This property supports case-insensitive filtering. path Type: string Local path to a location within the file system. With NFS, each export must have a unique local path. By default, the system exports the root of the file system (top-most directory) at the time the file system is created. This path specifies the unique location of the file system on the storage system.
Kerberos Allow only Kerberos security for user authentication. ◦ Kerberos_With_Integrity- Allow only Kerberos with integrity and Kerberos with encryption security for user authentication. ◦ Kerberos_With_Encryption- Allow only Kerberos with encryption security for user authentication. nfs_owner_username Type: string (Applies to NFS shares of VMware NFS storage resources.) Default owner of the NFS Export associated with the datastore. Required if secure NFS enabled.
anonymous_UID Type: 32-bit signed integer Specifies the user ID of the anonymous account. anonymous_GID Type: 32-bit signed integer Specifies the group ID of the anonymous account. is_no_SUID Type: boolean If set, do not allow access to set SUID. Otherwise, allow access. default_access_l10n Type: string Localized message string corresponding to default_access. min_security_l10n Type: string Localized message string corresponding to min_security.
Attribute Select file_system.access_type X file_system.access_type_l10n X file_system.creation_timestamp X file_system.creator_type X file_system.creator_type_l10n X file_system.default_hard_limit X file_system.default_soft_limit X file_system.description X file_system.expiration_timestamp X file_system.filesystem_type X file_system.filesystem_type_l10n X file_system.folder_rename_policy X file_system.folder_rename_policy_l10n X file_system.grace_period X file_system.
Attribute Select Sort Search file_system.is_smb_op_locks_enabled X file_system.is_smb_sync_writes_enabled X file_system.last_refresh_timestamp X file_system.last_writable_timestamp X file_system.locking_policy X file_system.locking_policy_l10n X file_system.name X file_system.nas_server_id X file_system.parent_id X file_system.protection_policy_id X file_system.size_total X file_system.size_used X file_system.
Attribute Select Sort Search path X X X read_only_hosts X X X read_only_root_hosts X X X read_write_hosts X X X read_write_root_hosts X X X Format nfs_export [ { -id | -name } ] show [ -select ,… ] [ -sort [+|-],… ] [ -offset ] [ { -limit | -all } ] [ -query ] [ -output { nvp | csv [ -table ] [ -noformat ] | table | json [ -raw ] } ] Action qualifiers -id NFS Export object id.
-output Change the output format. nvp Display output as plain text. csv Display output in CSV format. table Display output in a table. json Display output in JSON format. create Create an NFS Export for a Snapshot.
◦ Read_Write- Allow read write access to the Export for the hosts. Root Allow read write access to the Export for the hosts. Allow access to the Export for root user. ◦ Read_Only_Root- Allow read only root access to the Export for the hosts. -min_security NFS enforced security type for users accessing an NFS Export. Sys Allow the user to authenticate with any NFS security types: UNIX, Kerberos, Kerberos with integrity, or Kerberos with encryption.
-anonymous_GID Specifies the group ID of the anonymous account. -is_no_SUID If set, do not allow access to set SUID. Otherwise, allow access. -async Perform asynchronous operation. delete Delete NFS Export. Format nfs_export { -id | -name } delete [ -async ] Action qualifiers -id NFS Export object id. -name Unique name of the existing object (nfs_export). -async Perform asynchronous operation. set Modify NFS Export Properties.
-name Unique name of the existing object (nfs_export). -description NFS Export description. -default_access Default access level for all hosts that can access the Export. ◦ No_Access- Deny access to the Export for the hosts. ◦ Read_Only- Allow read only access to the Export for the hosts. ◦ Read_Write- Allow read write access to the Export for the hosts. Root Allow read write access to the Export for the hosts. Allow access to the Export for root user.
-read_only_hosts Hosts with read-only access to the NFS export and its snapshots. Hosts can be entered by Hostname, IP addresses (IPv4, IPv6, IPv4/PrefixLength, IPv6/PrefixLenght, or IPv4/subnetmask), or Netgroups prefixed with @. -add_read_only_hosts Hosts to add to the current read_only_hosts list. Hosts can be entered by Hostname, IP addresses (IPv4, IPv6, IPv4/PrefixLength, IPv6/PrefixLenght, or IPv4/subnetmask), or Netgroups prefixed with @. Error if the host already exists.
Netgroups prefixed with @. Error if Host is not present. Cannot combine with read_write_hosts. -read_write_root_hosts Hosts with read and write and read and write for root user access to the NFS Export and its snapshots. Hosts can be entered by Hostname, IP addresses (IPv4, IPv6, IPv4/PrefixLength, IPv6/PrefixLenght, or IPv4/subnetmask), or Netgroups prefixed with @. -add_read_write_root_hosts Hosts to add to the current read_write_root_hosts list.
host_name Type: string The name that will be used by NFS clients to connect to this NFS server. This name is required when using secure NFS, except when is_use_smb_config_enabled is true. In this case host_name is forced to the SMB server computer name, and must not be specified. nas_server_id Type: string The unique identifier of the NAS server that serves this share. is_nfsv3_enabled Type: boolean Indicates whether NFSv3 is enabled on the NAS server. When enabled, NFS shares can be accessed with NFSv3.
is_joined Type: boolean Indicates whether the NFS server is joined to Active Directory. Required for Secure NFS. Always false when secure NFS is disabled and kdc_type is not MS Windows. is_extended_credentials_enabled Type: boolean Indicates whether the NFS server supports more than 16 Unix groups in a Unix credential. Valid values are: - true - NFS server supports more than 16 Unix groups in a Unix credential. The NFS server will send additional request to Unix Directory service to identify Unix groups.
Attribute Select Sort Search is_secure_enabled X X X is_use_smb_config_enabled X X X nas_server.backup_IPv4_interface_id X nas_server.backup_IPv6_interface_id X nas_server.current_node_id X nas_server.current_preferred_IPv4_interface_id X nas_server.current_preferred_IPv6_interface_id X nas_server.current_unix_directory_service X nas_server.current_unix_directory_service_l10n X nas_server.default_unix_user X nas_server.default_windows_user X nas_server.
Attribute Select Sort Search nas_server_id X X X service_principal_name X X X Format nfs_server [ -id ] show [ -select ,… ] [ -sort [+|-],… ] [ -offset ] [ { -limit | -all } ] [ -query ] [ -output { nvp | csv [ -table ] [ -noformat ] | table | json [ -raw ] } ] Action qualifiers -id Unique identifier of the NFS server. -select Display selected attributes in the output. -sort Sorts output field+ (or just field) sort by field in ascending order.
json Display output in JSON format. create Create an NFS server. Format nfs_server create -nas_server_id [ -host_name ] [ -is_nfsv3_enabled { yes | true | no | false } ] [ -is_nfsv4_enabled { yes | true | no | false } ] [ -is_secure_enabled { yes | true | no | false } ] [ -is_use_smb_config_enabled { yes | true | no | false } ] [ -is_extended_credentials_enabled { yes | true | no | false } ] [ -credentials_cache_TTL <1..
-is_extended_credentials_enabled Indicates whether the NFS server supports more than 16 Unix groups in a Unix credential. Valid values are: - true - NFS server supports more than 16 Unix groups in a Unix credential. The NFS server will send additional request to Unix Directory service to identify Unix groups. - false - NFS server supports more than 16 Unix groups in a Unix credential. The NFS server will send additional request to Unix Directory service to identify Unix groups.
Action qualifiers -id Unique identifier of the NFS server. -host_name The name that will be used by NFS clients to connect to this NFS server. This name is required when using secure NFS, except when is_use_smb_config_enabled is true. In this case host_name is forced to the SMB server computer name, and must not be specified. -is_nfsv3_enabled Indicates whether NFSv3 is enabled on the NAS server. When enabled, NFS shares can be accessed with NFSv3.
-credentials_cache_TTL Sets the Time-To-Live (in minutes) expiration stamp for a Windows entry in the credentials cache. When failed mapping entries expire, the system retries mapping the UID to the SID. -async Perform asynchronous operation. join Join the secure NFS server to the NAS server’s AD domain, which is necessary for Secure NFS.
-domain_password Password of the domain-user specified to unjoin from the Active Directory domain. -domain_passwordSecure Secure version of -domain_password. Value will be queried interactively. -async Perform asynchronous operation. performance_rule Information about performance rules that can be use in performance policies applied to volumes and volume groups. Quality of service rule in a performance policy for policy based management of storage resources.
Attribute Select Sort Search io_priority_l10n X X X name X X X policies.description X policies.id X policies.is_replica X policies.name X policies.type X policies.type_l10n X Format performance_rule [ { -id | -name } ] show [ -select ,… ] [ -sort [+|-],… ] [ -offset ] [ { -limit | -all } ] [ -query ] [ -output { nvp | csv [ -table ] [ -noformat ] | table | json [ -raw ] } ] Action qualifiers -id Performance Rule id.
-all Query all records. -query Query records that fulfill the specified condition. -output Change the output format. nvp Display output as plain text. csv Display output in CSV format. table Display output in a table. json Display output in JSON format. smb_server Use these resource types to manage Server Message Block (SMB) servers. SMB is a protocol for sharing files and communications abstractions such as named pipes and mail slots between computers.
Directory domain. This name’s minimum length is 2 characters, it is limited to 63 bytes and must not contain the following characters - - comma (.) - tilde (~) - colon (:) - exclamation point (!) - at sign (@) - number sign (#) - dollar sign ($) - percent (%) - caret (^) - ampersand (&) - apostrophe (') - period (.
details show Property capabilities Attribute Select Sort Search computer_name X X X description X X X domain X X X id X X X is_joined X X X is_standalone X X X nas_server.backup_IPv4_interface_id X nas_server.backup_IPv6_interface_id X nas_server.current_node_id X nas_server.current_preferred_IPv4_interface_id X nas_server.current_preferred_IPv6_interface_id X nas_server.current_unix_directory_service X nas_server.current_unix_directory_service_l10n X nas_server.
Attribute Select Sort Search nas_server.name X nas_server.operational_status X nas_server.operational_status_l10n X nas_server.preferred_node_id X nas_server.production_IPv4_interface_id X nas_server.
-all Query all records. -query Query records that fulfill the specified condition. -output Change the output format. nvp Display output as plain text. csv Display output in CSV format. table Display output in a table. json Display output in JSON format. create Create an SMB server.
(#) - dollar sign ($) - percent (%) - caret (^) - ampersand (&) - apostrophe (') - period (.) - note that if you enter string with period only the first word will be kept - parentheses (()) - braces ({}) - underscore (_) - white space (blank) as defined by the Microsoft naming convention (see https://support.microsoft.com/en-us/help/909264/) -domain Domain name where SMB server is registered in Active Directory, if applicable. -netbios_name NetBIOS name is the network name of the standalone SMB server.
set Modify an SMB server’s settings. Format smb_server -id set [ -is_standalone { yes | true | no | false } ] [ -computer_name ] [ -domain ] [ -netbios_name ] [ -workgroup ] [ -description ] [ { -local_admin_password | -local_admin_passwordSecure } ] [ -async ] Action qualifiers -id Unique identifier of the SMB server. -is_standalone Indicates whether the SMB server is standalone. Values are: - true - SMB server is standalone.
-local_admin_passwordSecure Secure version of -local_admin_password. Value will be queried interactively. -async Perform asynchronous operation. join Join the SMB server to an Active Directory domain. Format smb_server -id join -domain_user_name { -domain_password | -domain_passwordSecure } [ -organizational_unit ] [ -reuse_computer_account { yes | true | no | false } ] [ -async ] Action qualifiers -id Unique identifier of the SMB server.
-id Unique identifier of the SMB server. -domain_user_name Name of a domain-user with sufficient privileges to unjoin from the Active Directory domain. -domain_password Password of the domain-user specified to unjoin from the Active Directory domain. -domain_passwordSecure Secure version of -domain_password. Value will be queried interactively. -is_skip_AD_unjoin If set to yes: Will not remove the account from the Active Directory. This is to be used in case that no DC is available.
filesystem named svr1fs1, which is on the /svr1fs1 mountpoint of the NAS Server, use /svr1fs1 in the path parameter. SMB shares allow you to create multiple network shares for the same local path. description Type: string User defined SMB share description. is_continuous_availability_enabled Type: boolean Indicates whether continuous availability for Server Message Block (SMB) 3.0 is enabled for the SMB Share. Values are: - true - Continuous availability for SMB 3.0 is enabled for the SMB Share.
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 (default). umask Type: string The default UNIX umask for new files created on the Share. If not specified the umask defaults to 022. offline_availability_l10n Type: string Localized message string corresponding to offline_availability.
Attribute Select file_system.default_soft_limit X file_system.description X file_system.expiration_timestamp X file_system.filesystem_type X file_system.filesystem_type_l10n X file_system.folder_rename_policy X file_system.folder_rename_policy_l10n X file_system.grace_period X file_system.id X file_system.is_async_MTime_enabled X file_system.is_modified X file_system.is_quota_enabled X file_system.is_smb_no_notify_enabled X file_system.
Attribute Select Sort Search file_system.name X file_system.nas_server_id X file_system.parent_id X file_system.protection_policy_id X file_system.size_total X file_system.size_used X file_system.
-id SMB Share object id. -name Unique name of the existing object (smb_share). -select Display selected attributes in the output. -sort Sorts output field+ (or just field) sort by field in ascending order. field- sort by field in descending order. -offset Start record list starting from specific value. -limit Limits the number of listed records. -all Query all records. -query Query records that fulfill the specified condition. -output Change the output format. nvp Display output as plain text.
false } ] [ -offline_availability { Manual | Documents | Programs | None } ] [ -umask ] [ -is_continuous_availability_enabled { yes | true | no | false } ] [ -is_encryption_enabled { yes | true | no | false } ] [ -async ] Action qualifiers -file_system_id Unique identifier of the file system on which the SMB Share will be created. -path Local path to the file system or any existing sub-folder of the file system that is shared over the network.
-umask The default UNIX umask for new files created on the Share. If not specified the umask defaults to 022. -is_continuous_availability_enabled Indicates whether continuous availability for Server Message Block (SMB) 3.0 is enabled for the SMB Share. Values are: - true - Continuous availability for SMB 3.0 is enabled for the SMB Share. - false - Continuous availability for SMB 3.0 is disabled for the SMB Share. -is_encryption_enabled Indicates whether encryption for Server Message Block (SMB) 3.
-id SMB share object id. -name Unique name of the existing object (smb_share). -description NFS Share description. -is_ABE_enabled Indicates whether Access-based Enumeration (ABE) is enabled. ABE filters the list of available files and folders on a server to include only those, that the requesting user has access to. Values are: - true - ABE is enabled. - false - ABE is disabled. -is_branch_cache_enabled Indicates whether BranchCace optimization is enabled.
-async Perform asynchronous operation. storage_container Manage storage containers. A storage container is a logical grouping of related storage objects in a cluster. A storage container corresponds to a vVol datastore in vCenter and is used to group related vVols and track the amount of space that is used/free. A storage container is a logical grouping of related storage objects. For example, a storage container maps to a vVol datastore in vSphere where the storage for virtual machines can be provisioned.
Attribute Select virtual_volumes.appliance_id X virtual_volumes.creation_timestamp X virtual_volumes.creator_type X virtual_volumes.creator_type_l10n X virtual_volumes.family_id X virtual_volumes.id X virtual_volumes.io_priority X virtual_volumes.io_priority_l10n X virtual_volumes.is_readonly X virtual_volumes.location_history X virtual_volumes.migration_session_id X virtual_volumes.name X virtual_volumes.parent_id X virtual_volumes.profile_id X virtual_volumes.
Attribute Select virtual_volumes.usage_type_l10n X virtual_volumes.virtual_machine_uuid X Sort Search Format storage_container [ { -id | -name } ] show [ -select ,… ] [ -sort [+|-],… ] [ -offset ] [ { -limit | -all } ] [ -query ] [ -output { nvp | csv [ -table ] [ -noformat ] | table | json [ -raw ] } ] Action qualifiers -id Storage container ID. -name Unique name of the existing object (storage_container).
csv Display output in CSV format. table Display output in a table. json Display output in JSON format. create Create a virtual volume (vVol) storage container. Format storage_container create -name [ -quota <0 .. 4611686018427387904 (4096.00P)> ] [ -async ] Action qualifiers -name Name for the storage container that is unique across all storage containers in the cluster. The name must be between 1 and 64 UTF-8 characters (inclusive), and not more than 127 bytes.
-async Perform asynchronous operation. set Modify a storage container. Format storage_container { -id | -name } set [ -name ] [ -quota <0 .. 4611686018427387904 (4096.00P)> ] [ -async ] Action qualifiers -id Storage container ID. -name Unique name of the existing object (storage_container). -name New name for the storage container that is unique across all storage containers in the cluster. The name must be between 1 and 64 UTF-8 characters (inclusive), and not more than 127 bytes.
-async Perform asynchronous operation. unmount Unmount a storage container, which removes the vVol datastore from vCenter. Format storage_container { -id | -name } unmount [ -async ] Action qualifiers -id Storage container ID. -name Unique name of the existing object (storage_container). -async Perform asynchronous operation. virtual_volume Information about virtual volumes, which are managed through vCenter. A virtual volume.
The logical type of a virtual volume. usage_type Type: enumerated value ("Config", "Data", "Memory", "Other", "Swap") VMware’s usage of the vVol. appliance_id Type: string The appliance where the virtual volume resides. storage_container_id Type: string The storage container where the virtual volume resides. io_priority Type: enumerated value ("High", "Low", "Medium") The I/O priority for quality of service rules. profile_id Type: string The ID of the storage profile governing this virtual volume.
family_id Type: string Family id of the virtual volume. This is the id of the primary object at the root of the family tree. For a primary virtual volume this will be the same as the id of the object. For snap-sets and clone vVols it will be set to the source objects family ID. parent_id Type: string For snapshots and clones, the ID of the parent virtual volume. The parent_id is set when an virtual volume is created and will only change if its parent virtual volume is deleted.
Localized message string corresponding to io_priority. creator_type_l10n Type: string Localized message string corresponding to creator_type. appliance This is the embeddable reference form of appliance_id attribute. See appliance for more details storage_container This is the embeddable reference form of storage_container_id attribute. See form of migration_session_id attribute.
to_appliance_id Unique identifier of the appliance to which the volume was relocated. reason Reason for storage resource relocation. Initial Initial placement. Manual Manual migration operation initiated by user. Recommended Storage system recommended migration. migrated_on Time when the storage resource location changed. reason_l10n Localized message string corresponding to reason show Property capabilities Attribute Select appliance.drive_failure_tolerance_level X appliance.
Attribute Select child_virtual_volumes.creator_type_l10n X child_virtual_volumes.family_id X child_virtual_volumes.id X child_virtual_volumes.io_priority X child_virtual_volumes.io_priority_l10n X child_virtual_volumes.is_readonly X child_virtual_volumes.location_history X child_virtual_volumes.migration_session_id X child_virtual_volumes.name X child_virtual_volumes.parent_id X child_virtual_volumes.profile_id X child_virtual_volumes.size X child_virtual_volumes.
Attribute Select Sort Search creator_type X X X creator_type_l10n X X X family_id X X X host_virtual_volume_mappings.host_group_id X host_virtual_volume_mappings.host_id X host_virtual_volume_mappings.id X host_virtual_volume_mappings.virtual_volume_id X id X X X io_priority X X X io_priority_l10n X X X is_readonly X X X location_history X X X migration_session.created_timestamp X migration_session.current_transfer_rate X migration_session.
Attribute Select Sort Search migration_session.resource_type X migration_session.resource_type_l10n X migration_session.source_appliance_id X migration_session.state X migration_session.state_l10n X migration_session_id X X X name X X X parent.appliance_id X parent.creation_timestamp X parent.creator_type X parent.creator_type_l10n X parent.family_id X parent.id X parent.io_priority X parent.io_priority_l10n X parent.is_readonly X parent.location_history X parent.
Attribute Select Sort Search parent.size X parent.source_id X parent.source_timestamp X parent.storage_container_id X parent.type X parent.type_l10n X parent.usage_type X parent.usage_type_l10n X parent.virtual_machine_uuid X parent_id X X X profile_id X X X size X X X source.appliance_id X source.creation_timestamp X source.creator_type X source.creator_type_l10n X source.family_id X source.id X source.io_priority X source.io_priority_l10n X source.
Attribute Select Sort Search source.location_history X source.migration_session_id X source.name X source.parent_id X source.profile_id X source.size X source.source_id X source.source_timestamp X source.storage_container_id X source.type X source.type_l10n X source.usage_type X source.usage_type_l10n X source.virtual_machine_uuid X source_id X X X source_timestamp X X X storage_container.id X storage_container.name X storage_container.
Attribute Select target_virtual_volumes.creation_timestamp X target_virtual_volumes.creator_type X target_virtual_volumes.creator_type_l10n X target_virtual_volumes.family_id X target_virtual_volumes.id X target_virtual_volumes.io_priority X target_virtual_volumes.io_priority_l10n X target_virtual_volumes.is_readonly X target_virtual_volumes.location_history X target_virtual_volumes.migration_session_id X target_virtual_volumes.name X target_virtual_volumes.
Attribute Select Sort Search target_virtual_volumes.virtual_machine_uuid X type X X X type_l10n X X X usage_type X X X usage_type_l10n X X X virtual_machine_uuid X X X virtual_machines.cpu_count X virtual_machines.description X virtual_machines.guest_os X virtual_machines.id X virtual_machines.instance_uuid X virtual_machines.is_consistent X virtual_machines.is_consistent_snaps_supported X virtual_machines.memory_mb X virtual_machines.name X virtual_machines.
Attribute Select virtual_machines.vcenter_id X virtual_machines.vcenter_instance_uuid X Sort Search Format virtual_volume [ { -id | -name } ] show [ -select ,… ] [ -sort [+|-],… ] [ -offset ] [ { -limit | -all } ] [ -query ] [ -output { nvp | csv [ -table ] [ -noformat ] | table | json [ -raw ] } ] Action qualifiers -id Id of the virtual volume. -name Unique name of the existing object (virtual_volume).
csv Display output in CSV format. table Display output in a table. json Display output in JSON format. delete Delete a virtual volume. Format virtual_volume { -id | -name } delete [ -force { yes | true | no | false } ] [ -async ] Action qualifiers -id Unique identifier of the virtual volume to delete. -name Unique name of the existing object (virtual_volume). -force Normally, attempting to delete a bound virtual volume is not permitted.
description Type: string Description of the volume. This value must contain 128 or fewer printable Unicode characters. type Type: enumerated value ("Clone", "Primary", "Snapshot") Type of volume. Primary A base object. Clone A read-write object that shares storage with the object from which it is sourced. Snapshot A read-only object created from a volume or clone. wwn Type: string World wide name of the volume. [Added in 2.0.0.
Initializing Volume is starting but not yet ready for use. Offline Volume is not available. Destroying Volume is being deleted. No new operations are allowed. size Type: size (1048576 (1.00M) to 281474976710656 (256.00T)) Size of the volume in bytes. Minimum volume size is 1MB. Maximum volume size is 256TB. Size must be a multiple of 8192.
migration_session_id Type: string Unique identifier of the migration session assigned to the volume if it is part of a migration activity. protection_data Type: object Protection data associated with a resource. Filtering on the fields of this embedded resource is not supported. See protection_data for more details location_history Type: array of objects Filtering on the fields of this embedded resource is not supported.
host_volume_mapping for more details volume_groups List of the volume_groups that are associated with this volume. See volume_group for more details Attributes of protection_data created_by_rule_id Unique identifier of the snapshot rule that created the snapshot. created_by_rule_name The name of the rule that created the snapshot. This value will not change if the name of the rule changes after creating the snapshot.
creator_type_l10n Localized message string corresponding to creator_type Attributes of location_history from_appliance_id Unique identifier of the appliance from which the volume was relocated. to_appliance_id Unique identifier of the appliance to which the volume was relocated. reason Reason for storage resource relocation. Initial Initial placement. Manual Manual migration operation initiated by user. Recommended Storage system recommended migration.
Attribute Select Sort Search appliance_id X X X creation_timestamp X X X description X X X id X X X is_replication_destination X X X location_history X X X mapped_volumes.host_group_id X mapped_volumes.host_id X mapped_volumes.id X mapped_volumes.logical_unit_number X mapped_volumes.volume_id X migration_session.created_timestamp X migration_session.current_transfer_rate X migration_session.destination_appliance_id X migration_session.
Attribute Select Sort Search migration_session.resource_type_l10n X migration_session.source_appliance_id X migration_session.state X migration_session.state_l10n X migration_session_id X X X name X X X nguid X X X node_affinity X X X node_affinity_l10n X X X nsid X X X performance_policy_id X X X protection_data X X X protection_policy.description X protection_policy.id X protection_policy.is_replica X protection_policy.name X protection_policy.
Attribute Select Sort Search state_l10n X X X type X X X type_l10n X X X volume_groups.creation_timestamp X volume_groups.description X volume_groups.id X volume_groups.is_importing X volume_groups.is_protectable X volume_groups.is_replication_destination X volume_groups.is_write_order_consistent X volume_groups.location_history X volume_groups.migration_session_id X volume_groups.name X volume_groups.placement_rule X volume_groups.protection_data X volume_groups.
Action qualifiers -id Unique identifier of the volume to query. -name Unique name of the existing object (volume). -select Display selected attributes in the output. -sort Sorts output field+ (or just field) sort by field in ascending order. field- sort by field in descending order. -offset Start record list starting from specific value. -limit Limits the number of listed records. -all Query all records. -query Query records that fulfill the specified condition. -output Change the output format.
Format volume create -name -size <1048576 (1.00M) .. 281474976710656 (256.00T)> [ -host_id ] [ -host_group_id ] [ -logical_unit_number <0..16383> ] [ -description ] [ -appliance_id ] [ -volume_group_id ] [ -min_size <0 .. 9223372036854775807 (8192.00P)> ] [ -sector_size <512..4096> ] [ -protection_policy_id ] [ -performance_policy_id ] [ -async ] Action qualifiers -name Unique name for the volume to be created.
-performance_policy_id Unique identifier of the performance policy assigned to the volume. -async Perform asynchronous operation. delete Delete a volume. • A volume which is attached to a host or host group or is a member of a volume group cannot be deleted. • A volume which has protection policies attached to it cannot be deleted. • A volume which has snapshots that are part of a snapset cannot be deleted. • Clones of a deleted production volume or a clone are not deleted.
-name Unique name of the existing object (volume). -name New name of the volume. This value must contain 128 or fewer printable Unicode characters. -description New description of the volume. This value must contain 128 or fewer printable Unicode characters. -size New size of the volume in bytes, must be a multiple of 8192, must be bigger than the current volume size. Maximum volume size is 256TB. -expiration_timestamp New expiration time of the snapshot.
attach Attach a volume to a host or host group. Format volume { -id | -name } attach [ -host_id ] [ -host_group_id ] [ -logical_unit_number <0..16383> ] [ -async ] Action qualifiers -id Unique identifier of volume to attach. -name Unique name of the existing object (volume). -host_id Unique identifier of the host to be attached to the volume. Only one of host_id or host_group_id can be supplied. -host_group_id Unique identifier of the host group to be attached to the volume.
-description Description of the clone. This value must contain 128 or fewer printable Unicode characters. -host_id Unique identifier of the host to be attached to the clone. Only one of host_id or host_group_id can be supplied. -host_group_id Unique identifier of the host group to be attached to the clone. Only one of host_id or host_group_id can be supplied. -logical_unit_number Optional logical unit number when creating a mapped volume.
-async Perform asynchronous operation. refresh Refresh the contents of the target volume from another volume in the same family. By default, a backup snapshot of the target volume is created before the target volume is refreshed. To skip creating a backup snapshot, set the create_backup_snap property to false in the refresh request. A profile for the backup snapshot is automatically generated if a custom profile is not specified.
-expiration_timestamp Time at which the snapshot will expire. Expired snapshots are deleted by the snapshot aging service that runs periodically in the background. If not specified, the snapshot never expires. Use a maximum timestamp value to set an expiration to never expire. -creator_type Creator type of the storage resource. * User - A resource created by a user. * System - A resource created by the replication engine. * Scheduler - A resource created by the snapshot scheduler.
-name Name of the snapshot to be created. This value must contain 128 or fewer printable Unicode characters. The default name of the volume snapshot is the date and time when the snapshot is taken. -description Description of the snapshot. This value must contain 128 or fewer printable Unicode characters. -performance_policy_id Unique identifier of the performance policy assigned to the snapshot. -expiration_timestamp Time at which the snapshot will expire.
-description Description of the snapshot. This value must contain 128 or fewer printable Unicode characters. -performance_policy_id Unique identifier of the performance policy assigned to the snapshot. -expiration_timestamp Time at which the snapshot will expire. Expired snapshots are deleted by the snapshot aging service that runs periodically in the background. If not specified, the snapshot never expires. Use a maximum timestamp value to set an expiration to never expire.
This is a derived field that is set internally. It enables/disables the following functionality: ◦ Whether a protection_policy can be applied to the group. ◦ Whether manual snapshots can be taken. ◦ Whether clones of the group can be created. protection_policy_id Type: string Unique identifier of the protection policy assigned to the volume group. This attribute is only applicable to primary and clone volume groups.
Clone A read-write object that shares storage with the object from which it is sourced. Snapshot A read-only object created from a volume or clone. is_replication_destination Type: boolean Indicates whether this volume group is a replication destination. A replication destination will be created by the system when a replication session is created. When there is an active replication session, all the user operations are restricted including modification, deletion, host operation, snapshot, clone, etc.
migration_session This is the embeddable reference form of migration_session_id attribute. See migration_session for more details volumes List of the volumes that are associated with this volume_group. See volume for more details Attributes of protection_data created_by_rule_id Unique identifier of the snapshot rule that created the snapshot. created_by_rule_name The name of the rule that created the snapshot. This value will not change if the name of the rule changes after creating the snapshot.
creator_type_l10n Localized message string corresponding to creator_type Attributes of location_history from_appliance_id Unique identifier of the appliance from which the volume was relocated. to_appliance_id Unique identifier of the appliance to which the volume was relocated. reason Reason for storage resource relocation. Initial Initial placement. Manual Manual migration operation initiated by user. Recommended Storage system recommended migration.
Attribute Select Sort Search location_history X X X migration_session.created_timestamp X migration_session.current_transfer_rate X migration_session.destination_appliance_id X migration_session.estimated_completion_timestamp X migration_session.family_id X migration_session.id X migration_session.last_sync_timestamp X migration_session.name X migration_session.progress_percentage X migration_session.resource_type X migration_session.resource_type_l10n X migration_session.
Attribute Select Sort Search protection_policy.is_replica X protection_policy.name X protection_policy.type X protection_policy.type_l10n X protection_policy_id X X X type X X X type_l10n X X X volumes.appliance_id X volumes.creation_timestamp X volumes.description X volumes.id X volumes.is_replication_destination X volumes.location_history X volumes.migration_session_id X volumes.name X volumes.nguid X volumes.node_affinity X volumes.
Attribute Select volumes.protection_policy_id X volumes.size X volumes.state X volumes.state_l10n X volumes.type X volumes.type_l10n X volumes.wwn X Sort Search Format volume_group [ { -id | -name } ] show [ -select ,… ] [ -sort [+|-],… ] [ -offset ] [ { -limit | -all } ] [ -query ] [ -output { nvp | csv [ -table ] [ -noformat ] | table | json [ -raw ] } ] Action qualifiers -id Unique identifier of the volume group.
-query Query records that fulfill the specified condition. -output Change the output format. nvp Display output as plain text. csv Display output in CSV format. table Display output in a table. json Display output in JSON format. create Create a new volume group. The resulting volume group will have a type of Primary.
consistent. This parameter defaults to true, if not specified. -protection_policy_id Unique identifier of an optional protection policy to assign to the volume group. -async Perform asynchronous operation. delete Delete a volume group, snapshot set, or clone. Before you try deleting a volume group, snapshot set, or clone, ensure that you first detach it from all hosts. Note the following: • When a volume group or clone is deleted, all related snapshot sets will also be deleted.
Action qualifiers -id Unique identifier of the volume group. -name Unique name of the existing object (volume_group). -name New name for the volume group. The name should contain no special HTTP characters and no unprintable characters. Although the case of the name provided is reserved, uniqueness check is case-insensitive, so the same name in two different cases is not considered unique. -description New description for the volume group. The description should not have any unprintable characters.
-force Normally a replication destination volume group cannot be modified since it is controlled by replication. However, there can be cases where replication has failed or is no longer active and the replication destination volume group needs to be cleaned up. With the force option, the user will be allowed to remove the protection policy from the replication destination volume group provided that the replication session has never been synchronized. This parameter defaults to false, if not specified.
• source_id will be set to the source_id of the source snapshot set. • source_time will be set to the source_time of the source snapshot set. The clone volume group will inherit the value of the is_write_order_consistent property from the source volume group. A clone of a snapshot set is modeled as a clone of the snapshot set’s source, created at the same time instant as when the source snapshot set was created.
snapshot set (C1S1)|source_time of source snapshot set (C1S1)| |Clone (C1) |Primary (P1)|id of primary (P1)|Current time| |Clone (C1) |snapshot set (S1) of primary (P1)|id of source snapshot set (S1)|source_time of source snapshot set (S1)| |Clone (C1) |Clone (C2)|id of source clone(C2)|Current time| |Clone (C1) |snapshot set (C2S1) of clone (C2)|id of source snapshot set (C2S1)|source_time of source snapshot set (C2S1)| Refresh operation is only supported if there are no membership changes betw
-async Perform asynchronous operation. remove_members Remove members from an existing primary or clone volume group. This cannot be used to remove members from a snapshot set. Members cannot be removed from a volume group that is a acting as the destination in a replication session. Format volume_group { -id | -name } remove_members { -volume_ids ,… | -volume_names ,… } [ -async ] Action qualifiers -id Unique identifier of the volume group.
-description ] [ -expiration_timestamp[Added in 2.0.0.0] ] ] [ -async ] Action qualifiers -id Unique identifier of the volume group. -name Unique name of the existing object (volume_group). -from_snap_id Unique identifier of the snapshot set to restore from. This is referred to as the source volume group. -create_backup_snap This parameter specifies whether a backup snapshot set of the target volume group needs to be created before attempting restore.
The is_write_order_consistent property of the source volume group determines whether the snapshot set will be write-order consistent. Format volume_group { -id | -name } snapshot -name [ -description ] [ -expiration_timestamp[Added in 2.0.0.0] ] [ -async ] Action qualifiers -id Unique identifier of the volume group. -name Unique name of the existing object (volume_group). -name Unique name of the snapshot set to be created.
id Type: string Unique identifier of the maintenance window. appliance_id Type: string Appliance id on which this maintenance window is configured. is_enabled Type: boolean Whether the maintenance window is active. end_time Type: date time Time when the maintenance window will close (or did close). appliance This is the embeddable reference form of appliance_id attribute. See appliance for more details show Property capabilities Attribute Select appliance.drive_failure_tolerance_level X appliance.
Attribute Select Sort Search id X X X is_enabled X X X Format maintenance_window [ -id ] show [ -select ,… ] [ -sort [+|-],… ] [ -offset ] [ { -limit | -all } ] [ -query ] [ -output { nvp | csv [ -table ] [ -noformat ] | table | json [ -raw ] } ] Action qualifiers -id Unique identifier of the maintenance window configuration. -select Display selected attributes in the output.
json Display output in JSON format. set Configure maintenance window. Format maintenance_window -id set [ -is_enabled { yes | true | no | false } ] [ -end_offset <0..172800> ] [ -async ] Action qualifiers -id Unique identifier of the maintenance window configuration. -is_enabled Activate or deactivate the window for one appliance. -end_offset Number of seconds from the current timestamp the maintenance window will expire.
show Property capabilities Attribute Select email X first_name X id X last_name X phone X Sort Search Format remote_support_contact [ -id[Added in 2.0.0.0] ] show [ -select ,… ] [ -output { nvp | csv [ -table ] [ -noformat ] | table | json [ -raw ] } ] Action qualifiers [Added in 2.0.0.0] -id The unique id of the remote_support_contact instance. Was added in version 2.0.0.0. -select Display selected attributes in the output. -output Change the output format.
Action qualifiers -id The unique id of the remote_support_contact instance. Was added in version 2.0.0.0. -last_name The last name of the support contact for this system. Was added in version 2.0.0.0. -first_name The first name of the support contact for this system. Was added in version 2.0.0.0. -email The email address of the support contact for this system. Was added in version 2.0.0.0. -phone The phone number of this support contact for this system. Was added in version 2.0.0.0.
Attribute Select appliance_id X id X is_ssh_enabled X Sort Search Format service_config [ -id ] show [ -select ,… ] [ -output { nvp | csv [ -table ] [ -noformat ] | table | json [ -raw ] } ] Action qualifiers -id Unique identifier of the instance. -select Display selected attributes in the output. -output Change the output format. nvp Display output as plain text. csv Display output in CSV format. table Display output in a table. json Display output in JSON format.
true Enables SSH access false Disables SSH access -async Perform asynchronous operation. service_user Use this resource type to manage the service user account. The system includes the default service_user account with the username 'service'. The service user account cannot authenticate through the REST, CLI, or graphical user interfaces. You cannot create more service user accounts or delete the default service user account.
Format service_user [ -id ] show [ -select ,… ] [ -output { nvp | csv [ -table ] [ -noformat ] | table | json [ -raw ] } ] Action qualifiers -id Unique identifier of the service user. -select Display selected attributes in the output. -output Change the output format. nvp Display output as plain text. csv Display output in CSV format. table Display output in a table. json Display output in JSON format. set Modify the properties of the service user account.
System and Hardware Manage hardware, view component health status, change cluster configuration appliance Manage appliances Properties of an appliance. This resource type has queriable associations from node, ip_pool_address, veth_port, maintenance_window, fc_port, sas_port, eth_port, software_installed, virtual_volume, hardware, volume Attributes id Type: string Unique identifier of the appliance. name Type: string Name of the appliance. This property supports case-insensitive filtering.
nodes This is the inverse of the resource type node association. See node for more details ip_pool_addresses This is the inverse of the resource type ip_pool_address association. See ip_pool_address for more details veth_ports This is the inverse of the resource type veth_port association. See veth_port for more details maintenance_windows This is the inverse of the resource type maintenance_window association.
Attribute Select eth_ports.bond_id X eth_ports.current_mtu X eth_ports.current_speed X eth_ports.current_speed_l10n X eth_ports.hardware_parent_id X eth_ports.hypervisor_port_id X eth_ports.hypervisor_port_name X eth_ports.hypervisor_vswitch_id X eth_ports.hypervisor_vswitch_name X eth_ports.id X eth_ports.io_module_id X eth_ports.is_hypervisor_managed X eth_ports.is_link_up X eth_ports.mac_address X eth_ports.name X eth_ports.node_id X eth_ports.partner_id X eth_ports.
Attribute Select eth_ports.requested_speed_l10n X eth_ports.sfp_id X eth_ports.stale_state X eth_ports.stale_state_l10n X eth_ports.supported_speeds X eth_ports.supported_speeds_l10n X express_service_code X fc_ports.appliance_id X fc_ports.current_speed X fc_ports.current_speed_l10n X fc_ports.hardware_parent_id X fc_ports.id X fc_ports.io_module_id X fc_ports.is_link_up X fc_ports.name X fc_ports.node_id X fc_ports.partner_id X fc_ports.port_connector_type X fc_ports.
Attribute Select fc_ports.protocols_l10n X fc_ports.requested_speed X fc_ports.requested_speed_l10n X fc_ports.sfp_id X fc_ports.stale_state X fc_ports.stale_state_l10n X fc_ports.supported_speeds X fc_ports.supported_speeds_l10n X fc_ports.wwn X fc_ports.wwn_nvme X hardware.appliance_id X hardware.extra_details X hardware.id X hardware.is_marked X hardware.lifecycle_state X hardware.lifecycle_state_l10n X hardware.name X hardware.parent_id X hardware.
Attribute Select hardware.stale_state X hardware.stale_state_l10n X hardware.status_led_state X hardware.status_led_state_l10n X hardware.type X hardware.type_l10n X id X ip_pool_addresses.address X ip_pool_addresses.appliance_id X ip_pool_addresses.id X ip_pool_addresses.ip_port_id X ip_pool_addresses.name X ip_pool_addresses.network_id X ip_pool_addresses.node_id X ip_pool_addresses.purposes X ip_pool_addresses.purposes_l10n X maintenance_windows.
Attribute Select Sort Search name X X X nodes.appliance_id X nodes.id X nodes.slot X sas_ports.appliance_id X sas_ports.hardware_parent_id X sas_ports.id X sas_ports.io_module_id X sas_ports.is_link_up X sas_ports.name X sas_ports.node_id X sas_ports.partner_id X sas_ports.port_index X sas_ports.sfp_id X sas_ports.speed X sas_ports.speed_l10n X sas_ports.stale_state X sas_ports.stale_state_l10n X service_tag X X X software_installed.
Attribute Select software_installed.build_id X software_installed.build_type X software_installed.build_type_l10n X software_installed.build_version X software_installed.id X software_installed.installed_date X software_installed.is_cluster X software_installed.release_timestamp X software_installed.release_version X veth_ports.appliance_id X veth_ports.current_mtu X veth_ports.current_speed X veth_ports.id X veth_ports.is_link_up X veth_ports.mac_address X veth_ports.
Attribute Select veth_ports.vswitch_port_name X virtual_volumes.appliance_id X virtual_volumes.creation_timestamp X virtual_volumes.creator_type X virtual_volumes.creator_type_l10n X virtual_volumes.family_id X virtual_volumes.id X virtual_volumes.io_priority X virtual_volumes.io_priority_l10n X virtual_volumes.is_readonly X virtual_volumes.location_history X virtual_volumes.migration_session_id X virtual_volumes.name X virtual_volumes.parent_id X virtual_volumes.
Attribute Select virtual_volumes.usage_type X virtual_volumes.usage_type_l10n X virtual_volumes.virtual_machine_uuid X volumes.appliance_id X volumes.creation_timestamp X volumes.description X volumes.id X volumes.is_replication_destination X volumes.location_history X volumes.migration_session_id X volumes.name X volumes.nguid X volumes.node_affinity X volumes.node_affinity_l10n X volumes.nsid X volumes.performance_policy_id X volumes.protection_data X volumes.
Attribute Select volumes.type X volumes.type_l10n X volumes.wwn X Sort Search Format appliance [ { -id | -name } ] show [ -select ,… ] [ -sort [+|-],… ] [ -offset ] [ { -limit | -all } ] [ -query ] [ -output { nvp | csv [ -table ] [ -noformat ] | table | json [ -raw ] } ] Action qualifiers -id Unique identifier of the appliance. -name Unique name of the existing object (appliance). -select Display selected attributes in the output.
nvp Display output as plain text. csv Display output in CSV format. table Display output in a table. json Display output in JSON format. [Added in 2.0.0.0] create Add an appliance to an existing cluster. The cluster consisting of a single appliance without a 4-Port Card installed cannot be extended. Before adding an appliance, verify whether the cluster has the appropriate number of unused IP addresses. Unused IP addresses for the Management and Storage Networks are required.
-drive_failure_tolerance_level Possible drive failure tolerance levels. Single A single drive failure can be tolerated without data loss. Double Two drive failure can be tolerated without data loss. Was added in version 2.0.0.0. -async Perform asynchronous operation. delete [Added in 2.0.0.0] Remove an appliance from a cluster. Was added in version 2.0.0.0. Format appliance { -id | -name } delete [ -async ] Action qualifiers -id Unique identifier of the appliance.
-async Perform asynchronous operation. forecast Forecast capacity usage for an appliance. Format appliance { -id | -name } forecast -metric_type { Physical_Space_Used_One_Day } [ -async ] Action qualifiers -id Unique id of the appliance. -name Unique name of the existing object (appliance). -metric_type Metric type to be forecast. -async Perform asynchronous operation. time_to_full Returns information about when an appliance is forecast to reach 100% capacity usage.
validate_create [Added in 2.0.0.0] Validate the add appliance configuration. Success is returned when all the validations have been run. The response includes any detected issues. Was added in version 2.0.0.0.
id Type: string Unique identifier of the bond. name Type: string Bond name. The bond name may not exceed 15 characters. This property supports case-insensitive filtering. partner_id [Added in 2.0.0.0] Type: string Identifier of the bond with the same physical location on the other node of the appliance. Partner ports are configured symmetrically for HA and load balancing purposes within the appliance. Was added in version 2.0.0.0. is_link_up Type: boolean Indicates whether the bond’s link is up.
Transmit_Load_Balancing Outgoing network traffic is distributed according to the current load on each interface. Incoming traffic is received by the current interface. If the receiving interface fails, another interface takes over the MAC address of the failed interface. This mode does not require any special switch support. Adaptive_Load_Balancing This mode includes Transmit Load Balancing (TLB) and Receive Load Balancing (RLB) for IPv4 traffic and does not require any special switch support.
Attribute Select eth_ports.appliance_id X eth_ports.bond_id X eth_ports.current_mtu X eth_ports.current_speed X eth_ports.current_speed_l10n X eth_ports.hardware_parent_id X eth_ports.hypervisor_port_id X eth_ports.hypervisor_port_name X eth_ports.hypervisor_vswitch_id X eth_ports.hypervisor_vswitch_name X eth_ports.id X eth_ports.io_module_id X eth_ports.is_hypervisor_managed X eth_ports.is_link_up X eth_ports.mac_address X eth_ports.name X eth_ports.node_id X eth_ports.
Attribute Select Sort Search eth_ports.requested_speed X eth_ports.requested_speed_l10n X eth_ports.sfp_id X eth_ports.stale_state X eth_ports.stale_state_l10n X eth_ports.supported_speeds X eth_ports.supported_speeds_l10n X id X X X ip_ports.available_usages X ip_ports.available_usages_l10n X ip_ports.bond_id X ip_ports.current_usages X ip_ports.current_usages_l10n X ip_ports.eth_port_id X ip_ports.id X ip_ports.partner_id X ip_ports.target_iqn X ip_ports.
Attribute Select Sort Search mtu X X X name X X X partner.description X partner.id X partner.is_link_up X partner.mode X partner.mode_l10n X partner.mtu X partner.name X partner.partner_id X partner.type X partner.
-select Display selected attributes in the output. -sort Sorts output field+ (or just field) sort by field in ascending order. field- sort by field in descending order. -offset Start record list starting from specific value. -limit Limits the number of listed records. -all Query all records. -query Query records that fulfill the specified condition. -output Change the output format. nvp Display output as plain text. csv Display output in CSV format. table Display output in a table.
name The name of the cluster. management_address The floating management IP address for the cluster in IPv4 or IPv6 format. storage_discovery_address The floating storage discovery IP address for the cluster in IPv4 or IPv6 format. If multiple storage discovery addresses are configured, this property will be set to "null". In this case the required storage network should be used to retrieve the discovery address. [Deprecated in 2.0.0.
state_l10n Localized string corresponding to state. system_time [Added in 2.0.0.0] Current clock time for the system. System time and all the system reported times are in UTC (GMT+0:00) format. The system time is controlled via NTP. It cannot be set directly. Was added in version 2.0.0.0.
Action qualifiers -id Unique identifier of the cluster. -select Display selected attributes in the output. -output Change the output format. nvp Display output as plain text. csv Display output in CSV format. table Display output in a table. json Display output in JSON format. [Added in 2.0.0.0] create Create a Power Store or Power Store X Cluster of one or more appliances. • You can create a cluster of up to 4 appliances.
<0..128> -addresses ,… [ -vlan_id <0..4094> ] [ -gateway ] [ -cluster_mgmt_address ] [ -storage_discovery_address ] )… ( [ -physical_switches -name -purpose { Data_and_Management | Management_Only } ( -connections -address -connect_method { SSH | SNMPv2c } [ -port <0..
-type Network type. Management External cluster and appliance management. Intra_Cluster_Management Management within the cluster. Intra_Cluster_Data Data within the cluster. Storage External data transfer. VMotion Data movement controlled by VMotion. -prefix_length Network prefix length, used for both IPv4 and IPv6. -addresses IP addresses in IPv4 or IPv6 format. -vlan_id VLAN identifier. -gateway Network gateway in IPv4 or IPv6 format, corresponding to the network’s IP version.
-connections Physical switch connection configuration setting during cluster creation. Was added in version 2.0.0.0. -address Physical switch address in IPv4 or IPv6 or DNS hostname format. -connect_method Physical switch connect method type. Valid values are: SSH Secure shell. SNMPv2c SNMPv2 community string. -port Port used for connection to switch. -username Username to connect a physical switch for SSH connection method.
-is_verify_server_cert Added for next release backward compatibility. In current release should be always set to "false". -vasa_provider_credentials Storage system credentials for vCenter to use for communicating with the storage system using VASA. Parameters are required when creating PowerStore X cluster and optional for PowerStore cluster. Was added in version 2.0.0.0. -username Username of the local user account which will be used by vSphere to register VASA provider.
traffic (management, data, and vmotion). This value must be in the range 1500-9000. -async Perform asynchronous operation. forecast Forecast capacity usage for the cluster. Format cluster -id forecast -metric_type { Physical_Space_Used_One_Day } [ -async ] Action qualifiers -id Unique id of the cluster. -metric_type Metric type to be forecast. -async Perform asynchronous operation. time_to_full Returns information about when the cluster is forecast to reach 100% capacity usage.
Format cluster validate_create -cluster -name [ -ignore_network_warnings { yes | true | no | false } ] ( -appliances -link_local_address [ -name ] [ -drive_failure_tolerance_level { Single | Double } ] )… -dns_servers ,… -ntp_servers ,… ( -networks -type { Management | Intra_Cluster_Management | Intra_Cluster_Data | Storage | VMotion } -prefix_length <0..128> -addresses ,… [ -vlan_id <0..
Was added in version 2.0.0.0. -networks Network configuration setting during cluster creation. Was added in version 2.0.0.0. -type Network type. Management External cluster and appliance management. Intra_Cluster_Management Management within the cluster. Intra_Cluster_Data Data within the cluster. Storage External data transfer. VMotion Data movement controlled by VMotion. -prefix_length Network prefix length, used for both IPv4 and IPv6. -addresses IP addresses in IPv4 or IPv6 format.
Data_and_Management Physical switch for all data and management networks. Management_Only Physical switch for management network only. -connections Physical switch connection configuration setting during cluster creation. Was added in version 2.0.0.0. -address Physical switch address in IPv4 or IPv6 or DNS hostname format. -connect_method Physical switch connect method type. Valid values are: SSH Secure shell. SNMPv2c SNMPv2 community string. -port Port used for connection to switch.
-passwordSecure Secure version of -password. Value will be queried interactively. -is_verify_server_cert Added for next release backward compatibility. In current release should be always set to "false". -vasa_provider_credentials Storage system credentials for vCenter to use for communicating with the storage system using VASA. Parameters are required when creating PowerStore X cluster and optional for PowerStore cluster. Was added in version 2.0.0.0.
appliance_id Type: string The id of the appliance containing the port. node_id Type: string Unique identifier of the hardware instance of type 'Node' containing the port. bond_id Type: string Unique identifier of the bond containing the port, or null if the port is not in a bond. mac_address Type: string Ethernet port MAC address. is_link_up Type: boolean Indicates whether the Ethernet port’s link is up. Values are: true Link is up. false Link is down.
100_Mbps 100 Megabits per second 1_Gbps 1 Gigabits per second 10_Gbps 10 Gigabits per second 25_Gbps 25 Gigabits per second 40_Gbps 40 Gigabits per second. requested_speed Type: enumerated value ("100_Mbps", "10_Gbps", "10_Mbps", "1_Gbps", "25_Gbps", "40_Gbps", "Auto") Supported Ethernet front-end port transmission speeds. For the current_speed attribute, these values show the current transmission speed on the port.
inserted into the port. io_module_id [Deprecated in 2.0.0.0] Type: string Unique identifier of the hardware instance of type 'IO_Module' handling the port. Was deprecated in version 2.0.0.0. hardware_parent_id [Added in 2.0.0.0] Type: string Unique identifier of the parent hardware instance handling the port. Was added in version 2.0.0.0. port_index Type: 32-bit signed integer (0 to 2147483647) The index of the Ethernet port in IO module.
SG SG Connector Optical_Pigtail Optical Pigtail Connector HSSDC_II High Speed Serial Data Connector Copper_Pigtail Copper Pigtail Connector RJ45 RJ45 Connector No_Separable No Separable Connector MXC_2x16 MXC 2x16 Connector. partner_id Type: string Unique identifier of the partner port instance. is_hypervisor_managed Type: boolean Indicates whether the port is managed by a hypervisor. hypervisor_port_name Type: string Hypervisor front-end port name capabilities.
Indicator of the stale state of the port. Was added in version 2.0.0.0. supported_speeds_l10n Type: array of strings Localized message array corresponding to supported_speeds. current_speed_l10n Type: string Localized message string corresponding to current_speed. requested_speed_l10n Type: string Localized message string corresponding to requested_speed. port_connector_type_l10n Type: string Localized message string corresponding to port_connector_type. stale_state_l10n [Added in 2.0.0.
more details partner This is the embeddable reference form of partner_id attribute. See eth_port for more details show Property capabilities Attribute Select appliance.drive_failure_tolerance_level X appliance.drive_failure_tolerance_level_l10n X appliance.express_service_code X appliance.id X appliance.model X appliance.name X appliance.service_tag X appliance_id X bond.description X bond.id X bond.is_link_up X bond.mode X bond.mode_l10n X bond.mtu X bond.name X bond.
Attribute Select Sort Search bond.type_l10n X bond_id X X X current_mtu X X X current_speed X X X current_speed_l10n X X X hardware_parent.appliance_id X hardware_parent.extra_details X hardware_parent.id X hardware_parent.is_marked X hardware_parent.lifecycle_state X hardware_parent.lifecycle_state_l10n X hardware_parent.name X hardware_parent.parent_id X hardware_parent.part_number X hardware_parent.serial_number X hardware_parent.slot X hardware_parent.
Attribute Select Sort Search hardware_parent.type_l10n X hardware_parent_id X X X hypervisor_port_id X X X hypervisor_port_name X X X hypervisor_vswitch_id X X X hypervisor_vswitch_name X X X id X X X io_module.appliance_id X io_module.extra_details X io_module.id X io_module.is_marked X io_module.lifecycle_state X io_module.lifecycle_state_l10n X io_module.name X io_module.parent_id X io_module.part_number X io_module.serial_number X io_module.
Attribute Select Sort Search io_module.status_led_state_l10n X io_module.type X io_module.type_l10n X io_module_id X X X ip_ports.available_usages X ip_ports.available_usages_l10n X ip_ports.bond_id X ip_ports.current_usages X ip_ports.current_usages_l10n X ip_ports.eth_port_id X ip_ports.id X ip_ports.partner_id X ip_ports.target_iqn X ip_ports.veth_port_id X is_hypervisor_managed X X X is_link_up X X X mac_address X X X name X X X node.
Attribute Select node.is_marked X node.lifecycle_state X node.lifecycle_state_l10n X node.name X node.parent_id X node.part_number X node.serial_number X node.slot X node.stale_state X node.stale_state_l10n X node.status_led_state X node.status_led_state_l10n X node.type X node.type_l10n X node_id X partner.appliance_id X partner.bond_id X partner.current_mtu X partner.current_speed X partner.current_speed_l10n X partner.
Attribute Select partner.hypervisor_port_id X partner.hypervisor_port_name X partner.hypervisor_vswitch_id X partner.hypervisor_vswitch_name X partner.id X partner.io_module_id X partner.is_hypervisor_managed X partner.is_link_up X partner.mac_address X partner.name X partner.node_id X partner.partner_id X partner.port_connector_type X partner.port_connector_type_l10n X partner.port_index X partner.requested_speed X partner.requested_speed_l10n X partner.
Attribute Select Sort Search partner.supported_speeds_l10n X partner_id X X X port_connector_type X X X port_connector_type_l10n X X X port_index X X X requested_speed X X X requested_speed_l10n X X X sfp.appliance_id X sfp.extra_details X sfp.id X sfp.is_marked X sfp.lifecycle_state X sfp.lifecycle_state_l10n X sfp.name X sfp.parent_id X sfp.part_number X sfp.serial_number X sfp.slot X sfp.stale_state X sfp.stale_state_l10n X sfp.
Attribute Select Sort Search sfp.status_led_state_l10n X sfp.type X sfp.
-all Query all records. -query Query records that fulfill the specified condition. -output Change the output format. nvp Display output as plain text. csv Display output in CSV format. table Display output in a table. json Display output in JSON format. set Change the properties of the front-end port. Note that setting the port’s requested speed may not cause the port speed to change immediately.
10_Mbps 10 Megabits per second 100_Mbps 100 Megabits per second 1_Gbps 1 Gigabits per second 10_Gbps 10 Gigabits per second 25_Gbps 25 Gigabits per second 40_Gbps 40 Gigabits per second -async Perform asynchronous operation. fc_port Use this resource type to retrieve information about Fibre Channel (FC) front-end ports and to set their connection speeds. Properties of the FC front-end port. Values was added in 2.0.0.0: wwn_nvme.
World Wide Name (WWN) of the port. wwn_nvme [Added in 2.0.0.0] Type: string World Wide Name (WWN) of NVME port. Was added in version 2.0.0.0. is_link_up Type: boolean Indicates whether the port’s link is up. Values are: true Link is up. false Link is down. supported_speeds Type: array of enumerated values ("16_Gbps", "32_Gbps", "4_Gbps", "8_Gbps", "Auto") List of supported transmission speeds for the port.
FrontEndPortSpeedEnum.yaml Auto the speed value is automatically detected 4_Gbps 4 Gigabits per second 8_Gbps 8 Gigabits per second 16_Gbps 16 Gigabits per second 32_Gbps 32 Gigabits per second. sfp_id Type: string Unique identifier of the hardware instance of type 'SFP' (Small Form-factor Pluggable) inserted into the port. io_module_id [Deprecated in 2.0.0.0] Type: string Unique identifier of the hardware instance of type 'IO_Module' handling the port. Was deprecated in version 2.0.0.0.
FC_Style2_Copper Fibre Channel Style 1 Copper Connector BNC_TNC Bayonet/Threaded Neill-Concelman Connector FC_Coaxial_Headers Fibre Channel Coaxial Headers Connector FiberJack Fiber Jack Connector LC Lucent Connector MT_RJ - Mechanical Transfer Registered Jack Connector MU Multiple Optical Connector SG SG Connector Optical_Pigtail Optical Pigtail Connector HSSDC_II High Speed Serial Data Connector Copper_Pigtail Copper Pigtail Connector RJ45 RJ45 Connector No_Separable No Separable
Localized message array corresponding to supported_speeds. current_speed_l10n Type: string Localized message string corresponding to current_speed. requested_speed_l10n Type: string Localized message string corresponding to requested_speed. port_connector_type_l10n Type: string Localized message string corresponding to port_connector_type. protocols_l10n [Added in 2.0.0.0] Type: array of strings Localized message array corresponding to protocols Was added in version 2.0.0.0. [Added in 2.0.0.
show Property capabilities Attribute Select Sort Search appliance.drive_failure_tolerance_level X appliance.drive_failure_tolerance_level_l10n X appliance.express_service_code X appliance.id X appliance.model X appliance.name X appliance.service_tag X appliance_id X X X current_speed X X X current_speed_l10n X X X hardware_parent.appliance_id X hardware_parent.extra_details X hardware_parent.id X hardware_parent.is_marked X hardware_parent.
Attribute Select Sort Search hardware_parent.slot X hardware_parent.stale_state X hardware_parent.stale_state_l10n X hardware_parent.status_led_state X hardware_parent.status_led_state_l10n X hardware_parent.type X hardware_parent.type_l10n X hardware_parent_id X X X id X X X io_module.appliance_id X io_module.extra_details X io_module.id X io_module.is_marked X io_module.lifecycle_state X io_module.lifecycle_state_l10n X io_module.name X io_module.
Attribute Select Sort Search io_module.stale_state_l10n X io_module.status_led_state X io_module.status_led_state_l10n X io_module.type X io_module.type_l10n X io_module_id X X X is_link_up X X X name X X X node.appliance_id X node.extra_details X node.id X node.is_marked X node.lifecycle_state X node.lifecycle_state_l10n X node.name X node.parent_id X node.part_number X node.serial_number X node.slot X node.stale_state X node.
Attribute Select node.status_led_state X node.status_led_state_l10n X node.type X node.type_l10n X node_id X partner.appliance_id X partner.current_speed X partner.current_speed_l10n X partner.hardware_parent_id X partner.id X partner.io_module_id X partner.is_link_up X partner.name X partner.node_id X partner.partner_id X partner.port_connector_type X partner.port_connector_type_l10n X partner.port_index X partner.protocols X partner.protocols_l10n X partner.
Attribute Select Sort Search partner.requested_speed_l10n X partner.sfp_id X partner.stale_state X partner.stale_state_l10n X partner.supported_speeds X partner.supported_speeds_l10n X partner.wwn X partner.wwn_nvme X partner_id X X X port_connector_type X X X port_connector_type_l10n X X X port_index X X X protocols X X X protocols_l10n X X X requested_speed X X X requested_speed_l10n X X X sfp.appliance_id X sfp.extra_details X sfp.id X sfp.
Attribute Select Sort Search sfp.lifecycle_state_l10n X sfp.name X sfp.parent_id X sfp.part_number X sfp.serial_number X sfp.slot X sfp.stale_state X sfp.stale_state_l10n X sfp.status_led_state X sfp.status_led_state_l10n X sfp.type X sfp.
Action qualifiers -id Unique identifier of the FC front-end port. -name Unique name of the existing object (fc_port). -select Display selected attributes in the output. -sort Sorts output field+ (or just field) sort by field in ascending order. field- sort by field in descending order. -offset Start record list starting from specific value. -limit Limits the number of listed records. -all Query all records. -query Query records that fulfill the specified condition. -output Change the output format.
appliance is set to the same requested speed. If the requested speed is not supported by the partner port, it is left unchanged. Format fc_port { -id | -name } set -requested_speed { Auto | 4_Gbps | 8_Gbps | 16_Gbps | 32_Gbps } [ -async ] Action qualifiers -id Unique identifier of the FC front-end port. -name Unique name of the existing object (fc_port). -requested_speed Possible Fibre Channel port speeds.
name Type: string The name of the component. This property supports case-insensitive filtering. type Type: enumerated value ("Appliance", "Base_Enclosure", "Battery", "DIMM", "Drive", "Expansion_Enclosure", "Fan", "IO_Module", "Link_Control_Card", "M2_Drive", "Node", "Power_Supply", "SFP") Hardware component type. lifecycle_state Type: enumerated value ("Disconnected", "Empty", "Failed", "Healthy", "Initializing", "Prepare_Failed", "Trigger_Update", "Uninitialized") Life cycle state of the component.
is_marked Type: boolean Indicator of whether a component is location marked or not. extra_details Type: object Additional hardware details. Contents are specific to each component type. See extra_details for more details [Added in 2.0.0.0] stale_state Type: enumerated value ("Disconnected", "Not_Stale") Indicator of the stale state of component. Was added in version 2.0.0.0. type_l10n Type: string Localized message string corresponding to type.
node_sas_ports This is the inverse of the resource type sas_port association. See sas_port for more details sfp_sas_ports This is the inverse of the resource type sas_port association. See sas_port for more details io_module_sas_ports [Deprecated in 2.0.0.0] This is the inverse of the resource type sas_port association. See sas_port for more details hardware_parent_sas_ports [Added in 2.0.0.0] This is the inverse of the resource type sas_port association.
bus_number Bus number of the Expansion_Shelf. Available on the Expansion_Shelf hardware type. enclosure_number Enclosure number of the Expansion_Shelf. Available on the Expansion_Shelf hardware type. model_name Model name of the hardware. Available on the IO_Module and M2_Drive hardware types. firmware_version Firmware version of the hardware. Available on the Drive hardware type. mode SFP mode. Available on the SFP hardware type. Current modes are: Unknown This SFP has unknown support.
FC_Style2_Copper Fibre Channel Style 1 Copper Connector BNC_TNC Bayonet/Threaded Neill-Concelman Connector FC_Coaxial_Headers Fibre Channel Coaxial Headers Connector FiberJack Fiber Jack Connector LC Lucent Connector MT_RJ - Mechanical Transfer Registered Jack Connector MU Multiple Optical Connector SG SG Connector Optical_Pigtail Optical Pigtail Connector HSSDC_II High Speed Serial Data Connector Copper_Pigtail Copper Pigtail Connector RJ45 RJ45 Connector No_Separable Non-seperable
encryption_status Indicates whether the drive is currently encrypted or not. Available on the Drive hardware type. Current statuses are: Not_Supported Drive does not support encryption. Supported_Unlocked Drive supports encryption but is not configured. Supported_Locked Drive supports encryption and is locked. Supported_Locked_Cluster_PIN Drive supports encryption and is configured. Supported_Locked_Out Drive supports encryption and is locked out.
supported_protocol_l10n Localized message string corresponding to supported_protocol connector_type_l10n Localized message string corresponding to connector_type drive_type_l10n Localized message string corresponding to drive_type encryption_status_l10n Localized message string corresponding to encryption_status fips_status_l10n Localized message string corresponding to fips_status show Property capabilities Attribute Select appliance.drive_failure_tolerance_level X appliance.
Attribute Select children.lifecycle_state_l10n X children.name X children.parent_id X children.part_number X children.serial_number X children.slot X children.stale_state X children.stale_state_l10n X children.status_led_state X children.status_led_state_l10n X children.type X children.type_l10n X extra_details X hardware_parent_eth_ports.appliance_id X hardware_parent_eth_ports.bond_id X hardware_parent_eth_ports.current_mtu X hardware_parent_eth_ports.
Attribute Select hardware_parent_eth_ports.hypervisor_vswitch_id X hardware_parent_eth_ports.hypervisor_vswitch_name X hardware_parent_eth_ports.id X hardware_parent_eth_ports.io_module_id X hardware_parent_eth_ports.is_hypervisor_managed X hardware_parent_eth_ports.is_link_up X hardware_parent_eth_ports.mac_address X hardware_parent_eth_ports.name X hardware_parent_eth_ports.node_id X hardware_parent_eth_ports.partner_id X hardware_parent_eth_ports.
Attribute Select hardware_parent_fc_ports.current_speed X hardware_parent_fc_ports.current_speed_l10n X hardware_parent_fc_ports.hardware_parent_id X hardware_parent_fc_ports.id X hardware_parent_fc_ports.io_module_id X hardware_parent_fc_ports.is_link_up X hardware_parent_fc_ports.name X hardware_parent_fc_ports.node_id X hardware_parent_fc_ports.partner_id X hardware_parent_fc_ports.port_connector_type X hardware_parent_fc_ports.port_connector_type_l10n X hardware_parent_fc_ports.
Attribute Select hardware_parent_fc_ports.wwn X hardware_parent_fc_ports.wwn_nvme X hardware_parent_sas_ports.appliance_id X hardware_parent_sas_ports.hardware_parent_id X hardware_parent_sas_ports.id X hardware_parent_sas_ports.io_module_id X hardware_parent_sas_ports.is_link_up X hardware_parent_sas_ports.name X hardware_parent_sas_ports.node_id X hardware_parent_sas_ports.partner_id X hardware_parent_sas_ports.port_index X hardware_parent_sas_ports.
Attribute Select io_module_eth_ports.current_speed_l10n X io_module_eth_ports.hardware_parent_id X io_module_eth_ports.hypervisor_port_id X io_module_eth_ports.hypervisor_port_name X io_module_eth_ports.hypervisor_vswitch_id X io_module_eth_ports.hypervisor_vswitch_name X io_module_eth_ports.id X io_module_eth_ports.io_module_id X io_module_eth_ports.is_hypervisor_managed X io_module_eth_ports.is_link_up X io_module_eth_ports.mac_address X io_module_eth_ports.
Attribute Select io_module_eth_ports.stale_state_l10n X io_module_eth_ports.supported_speeds X io_module_eth_ports.supported_speeds_l10n X io_module_fc_ports.appliance_id X io_module_fc_ports.current_speed X io_module_fc_ports.current_speed_l10n X io_module_fc_ports.hardware_parent_id X io_module_fc_ports.id X io_module_fc_ports.io_module_id X io_module_fc_ports.is_link_up X io_module_fc_ports.name X io_module_fc_ports.node_id X io_module_fc_ports.partner_id X io_module_fc_ports.
Attribute Select io_module_fc_ports.stale_state X io_module_fc_ports.stale_state_l10n X io_module_fc_ports.supported_speeds X io_module_fc_ports.supported_speeds_l10n X io_module_fc_ports.wwn X io_module_fc_ports.wwn_nvme X io_module_sas_ports.appliance_id X io_module_sas_ports.hardware_parent_id X io_module_sas_ports.id X io_module_sas_ports.io_module_id X io_module_sas_ports.is_link_up X io_module_sas_ports.name X io_module_sas_ports.node_id X io_module_sas_ports.
Attribute Select Sort Search lifecycle_state X X X lifecycle_state_l10n X X X name X X X node_eth_ports.appliance_id X node_eth_ports.bond_id X node_eth_ports.current_mtu X node_eth_ports.current_speed X node_eth_ports.current_speed_l10n X node_eth_ports.hardware_parent_id X node_eth_ports.hypervisor_port_id X node_eth_ports.hypervisor_port_name X node_eth_ports.hypervisor_vswitch_id X node_eth_ports.hypervisor_vswitch_name X node_eth_ports.id X node_eth_ports.
Attribute Select node_eth_ports.port_connector_type X node_eth_ports.port_connector_type_l10n X node_eth_ports.port_index X node_eth_ports.requested_speed X node_eth_ports.requested_speed_l10n X node_eth_ports.sfp_id X node_eth_ports.stale_state X node_eth_ports.stale_state_l10n X node_eth_ports.supported_speeds X node_eth_ports.supported_speeds_l10n X node_fc_ports.appliance_id X node_fc_ports.current_speed X node_fc_ports.current_speed_l10n X node_fc_ports.
Attribute Select node_fc_ports.port_connector_type_l10n X node_fc_ports.port_index X node_fc_ports.protocols X node_fc_ports.protocols_l10n X node_fc_ports.requested_speed X node_fc_ports.requested_speed_l10n X node_fc_ports.sfp_id X node_fc_ports.stale_state X node_fc_ports.stale_state_l10n X node_fc_ports.supported_speeds X node_fc_ports.supported_speeds_l10n X node_fc_ports.wwn X node_fc_ports.wwn_nvme X node_sas_ports.appliance_id X node_sas_ports.
Attribute Select node_sas_ports.port_index X node_sas_ports.sfp_id X node_sas_ports.speed X node_sas_ports.speed_l10n X node_sas_ports.stale_state X node_sas_ports.stale_state_l10n X parent.appliance_id X parent.extra_details X parent.id X parent.is_marked X parent.lifecycle_state X parent.lifecycle_state_l10n X parent.name X parent.parent_id X parent.part_number X parent.serial_number X parent.slot X parent.stale_state X parent.stale_state_l10n X parent.
Attribute Select Sort Search parent.type X parent.type_l10n X parent_id X X X part_number X X X serial_number X X X sfp_eth_ports.appliance_id X sfp_eth_ports.bond_id X sfp_eth_ports.current_mtu X sfp_eth_ports.current_speed X sfp_eth_ports.current_speed_l10n X sfp_eth_ports.hardware_parent_id X sfp_eth_ports.hypervisor_port_id X sfp_eth_ports.hypervisor_port_name X sfp_eth_ports.hypervisor_vswitch_id X sfp_eth_ports.hypervisor_vswitch_name X sfp_eth_ports.
Attribute Select sfp_eth_ports.node_id X sfp_eth_ports.partner_id X sfp_eth_ports.port_connector_type X sfp_eth_ports.port_connector_type_l10n X sfp_eth_ports.port_index X sfp_eth_ports.requested_speed X sfp_eth_ports.requested_speed_l10n X sfp_eth_ports.sfp_id X sfp_eth_ports.stale_state X sfp_eth_ports.stale_state_l10n X sfp_eth_ports.supported_speeds X sfp_eth_ports.supported_speeds_l10n X sfp_fc_ports.appliance_id X sfp_fc_ports.current_speed X sfp_fc_ports.
Attribute Select sfp_fc_ports.partner_id X sfp_fc_ports.port_connector_type X sfp_fc_ports.port_connector_type_l10n X sfp_fc_ports.port_index X sfp_fc_ports.protocols X sfp_fc_ports.protocols_l10n X sfp_fc_ports.requested_speed X sfp_fc_ports.requested_speed_l10n X sfp_fc_ports.sfp_id X sfp_fc_ports.stale_state X sfp_fc_ports.stale_state_l10n X sfp_fc_ports.supported_speeds X sfp_fc_ports.supported_speeds_l10n X sfp_fc_ports.wwn X sfp_fc_ports.wwn_nvme X sfp_sas_ports.
Attribute Select Sort Search sfp_sas_ports.node_id X sfp_sas_ports.partner_id X sfp_sas_ports.port_index X sfp_sas_ports.sfp_id X sfp_sas_ports.speed X sfp_sas_ports.speed_l10n X sfp_sas_ports.stale_state X sfp_sas_ports.
-select Display selected attributes in the output. -sort Sorts output field+ (or just field) sort by field in ascending order. field- sort by field in descending order. -offset Start record list starting from specific value. -limit Limits the number of listed records. -all Query all records. -query Query records that fulfill the specified condition. -output Change the output format. nvp Display output as plain text. csv Display output in CSV format. table Display output in a table.
-name Unique name of the existing object (hardware). -is_marked New state for the hardware component location marker LED. Setting it to true will put the LED in a blinking state until set to false. Note that the state returned in the hardware component may not actually change for up to 60 seconds. This operation is currently supported for Base_Enclosure, Expansion_Enclosure, Node and Drive.
Attributes id Type: string Unique identifier of the node. slot Type: 32-bit signed integer (0 to 2147483647) Slot number of the node. appliance_id Type: string Unique identifier of the appliance to which the node belongs. appliance This is the embeddable reference form of appliance_id attribute. See appliance for more details ip_pool_addresses This is the inverse of the resource type ip_pool_address association.
Attribute Select Sort Search appliance_id X X X id X X X ip_pool_addresses.address X ip_pool_addresses.appliance_id X ip_pool_addresses.id X ip_pool_addresses.ip_port_id X ip_pool_addresses.name X ip_pool_addresses.network_id X ip_pool_addresses.node_id X ip_pool_addresses.purposes X ip_pool_addresses.purposes_l10n X slot X X X veth_ports.appliance_id X veth_ports.current_mtu X veth_ports.current_speed X veth_ports.id X veth_ports.is_link_up X veth_ports.
Attribute Select veth_ports.vswitch_name X veth_ports.vswitch_port_group_name X veth_ports.vswitch_port_id X veth_ports.vswitch_port_name X Sort Search Format node [ -id ] show [ -select ,… ] [ -sort [+|-],… ] [ -offset ] [ { -limit | -all } ] [ -query ] [ -output { nvp | csv [ -table ] [ -noformat ] | table | json [ -raw ] } ] Action qualifiers -id Unique identifier of the node. -select Display selected attributes in the output.
csv Display output in CSV format. table Display output in a table. json Display output in JSON format. sas_port Use this resource type to retrieve information about SAS ports. This resource type has queriable associations from appliance, hardware, sas_port Attributes id Type: string Unique identifier of the SAS port. name Type: string Name of the SAS port. This property supports case-insensitive filtering. appliance_id Type: string Unique identifier of the appliance containing the port.
◦ 3_Gbps- 3 Gigabits per second ◦ 6_Gbps- 6 Gigabits per second ◦ 12_Gbps- 12 Gigabits per second. sfp_id Type: string Unique identifier of the hardware instance of type 'SFP' (Small Form-factor Pluggable) inserted into the port. io_module_id [Deprecated in 2.0.0.0] Type: string Unique identifier of the hardware instance of type 'IO_Module' handling the port. Was deprecated in version 2.0.0.0. hardware_parent_id [Added in 2.0.0.
details node This is the embeddable reference form of node_id attribute. See hardware for more details sfp This is the embeddable reference form of sfp_id attribute. See hardware for more details io_module This is the embeddable reference form of io_module_id attribute. See hardware for more details hardware_parent This is the embeddable reference form of hardware_parent_id attribute. See hardware for more details partner This is the embeddable reference form of partner_id attribute.
Attribute Select Sort Search hardware_parent.is_marked X hardware_parent.lifecycle_state X hardware_parent.lifecycle_state_l10n X hardware_parent.name X hardware_parent.parent_id X hardware_parent.part_number X hardware_parent.serial_number X hardware_parent.slot X hardware_parent.stale_state X hardware_parent.stale_state_l10n X hardware_parent.status_led_state X hardware_parent.status_led_state_l10n X hardware_parent.type X hardware_parent.
Attribute Select Sort Search io_module.lifecycle_state_l10n X io_module.name X io_module.parent_id X io_module.part_number X io_module.serial_number X io_module.slot X io_module.stale_state X io_module.stale_state_l10n X io_module.status_led_state X io_module.status_led_state_l10n X io_module.type X io_module.type_l10n X io_module_id X X X is_link_up X X X name X X X node.appliance_id X node.extra_details X node.id X node.is_marked X node.
Attribute Select node.name X node.parent_id X node.part_number X node.serial_number X node.slot X node.stale_state X node.stale_state_l10n X node.status_led_state X node.status_led_state_l10n X node.type X node.type_l10n X node_id X partner.appliance_id X partner.hardware_parent_id X partner.id X partner.io_module_id X partner.is_link_up X partner.name X partner.node_id X partner.partner_id X partner.
Attribute Select Sort Search partner.sfp_id X partner.speed X partner.speed_l10n X partner.stale_state X partner.stale_state_l10n X partner_id X X X port_index X X X sfp.appliance_id X sfp.extra_details X sfp.id X sfp.is_marked X sfp.lifecycle_state X sfp.lifecycle_state_l10n X sfp.name X sfp.parent_id X sfp.part_number X sfp.serial_number X sfp.slot X sfp.stale_state X sfp.stale_state_l10n X sfp.
Attribute Select Sort Search sfp.status_led_state_l10n X sfp.type X sfp.type_l10n X sfp_id X X X speed X X X speed_l10n X X X stale_state X X X stale_state_l10n X X X Format sas_port [ { -id | -name } ] show [ -select ,… ] [ -sort [+|-],… ] [ -offset ] [ { -limit | -all } ] [ -query ] [ -output { nvp | csv [ -table ] [ -noformat ] | table | json [ -raw ] } ] Action qualifiers -id Unique identifier of the SAS port.
-all Query all records. -query Query records that fulfill the specified condition. -output Change the output format. nvp Display output as plain text. csv Display output in CSV format. table Display output in a table. json Display output in JSON format. veth_port Use these resource types to manage the cluster-wide configuration of virtual IP ports, bonds, and virtual Ethernet ports. Properties of a virtual Ethernet port. Values was added in 2.0.0.0: partner_id.
name Type: string Virtual Ethernet port name. This property supports case-insensitive filtering. mac_address Type: string Virtual Ethernet port MAC address. is_link_up Type: boolean Indicates whether the virtual Ethernet port’s link is up. Values are: true Link is up. false Link is down. current_speed Type: 64-bit signed integer (0 to 9223372036854775807) Virtual Ethernet port transmission speed, in bits/sec (bps). current_mtu Type: size (0 to 2147483647 (1.
ip_ports This is the inverse of the resource type ip_port association. See ip_port for more details partner This is the embeddable reference form of partner_id attribute. See veth_port for more details appliance This is the embeddable reference form of appliance_id attribute. See appliance for more details node This is the embeddable reference form of node_id attribute. See node for more details show Property capabilities Attribute Select Sort Search appliance.
Attribute Select Sort Search ip_ports.current_usages X ip_ports.current_usages_l10n X ip_ports.eth_port_id X ip_ports.id X ip_ports.partner_id X ip_ports.target_iqn X ip_ports.veth_port_id X is_link_up X X X mac_address X X X name X X X node.appliance_id X node.id X node.slot X node_id X X X partner.appliance_id X partner.current_mtu X partner.current_speed X partner.id X partner.is_link_up X partner.mac_address X partner.
Attribute Select Sort Search partner.node_id X partner.partner_id X partner.vswitch_name X partner.vswitch_port_group_name X partner.vswitch_port_id X partner.
field- sort by field in descending order. -offset Start record list starting from specific value. -limit Limits the number of listed records. -all Query all records. -query Query records that fulfill the specified condition. -output Change the output format. 682 nvp Display output as plain text. csv Display output in CSV format. table Display output in a table. json Display output in JSON format.