Dell EMC PowerStore CLI Reference Guide © 2020 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. December 2020 Rev.
Table of Contents Compute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 discovered_initiator. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 show . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
refresh . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46 import_host_volume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46 show . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
discover . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111 import_vnx_consistency_group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111 show . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113 import_vnx_volume . . . . .
create . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195 delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196 set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ip_pool_address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245 show . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246 ip_port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249 show .
delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 290 set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 291 role . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 339 file_kerberos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 340 show . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 400 refresh . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 401 file_user_quota . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 402 show .
delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 446 set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 447 nfs_server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
refresh . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 510 restore . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 511 snapshot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
show . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 573 set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 578 hardware . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Compute Manage host configurations, virtual machines and VMware integration discovered_initiator List initiators currently connected to the cluster that are not associated with an initiator group or host. An initiator currently connected to the cluster, but not associated with any host. Attributes name IQN or WWN of the initiator protocol_type Protocol type of the host initiator. iSCSI An iSCSI initiator. FC A Fibre Channel initiator.
-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 Manage hosts that access the cluster. This resource type has queriable associations from host_group, import_host_system, host_volume_mapping, host_virtual_volume_mapping Attributes id Type: string Unique id of the host. name Type: string The host name. This property supports case-insensitive filtering.
Type: array of objects Filtering on the fields of this embedded resource is not supported. See host_initiators for more details os_type_l10n Type: string Localized message string corresponding to os_type. host_group This is the embeddable reference form of host_group_id attribute. See host_group for more details import_host_system This is the embeddable reference form of import_host_system_id attribute.
active_sessions Array of active login session between an initiator and a target port. See active_sessions for more details port_type_l10n Localized message string corresponding to port_type Attributes of active_sessions port_name IQN or WWN of the target port that the initiator is logged into. appliance_id Unique identifier of the appliance containing the session. node_id Unique identifier of node on the appliance on which active session is create.
Attribute Select Sort Search host_group_id X X X host_initiators 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 import_host_system.agent_address X import_host_system.agent_api_version X import_host_system.agent_port X import_host_system.agent_status X import_host_system.agent_status_l10n X import_host_system.
Attribute Select Sort Search mapped_hosts.host_group_id X mapped_hosts.host_id X mapped_hosts.id X mapped_hosts.logical_unit_number X mapped_hosts.volume_id X name X X X os_type X X X os_type_l10n X X X Format host [{-id | -name }] show [-select ,..] [-sort [+|-],..] [offset ] [{-limit | -all}] [-query ] [-output {nvp | csv [-table] [noformat] | table | json [-raw]}] Action qualifiers -id Unique id of the host.
-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 host.
Protocol type of the host initiator. iSCSI An iSCSI initiator. FC A Fibre Channel initiator. -chap_single_username Username for CHAP authentication. This value must be 1 to 64 UTF-8 characters. CHAP username is required when the cluster CHAP mode is mutual authentication. -chap_single_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.
-id Unique id of the host. -name Unique name of the existing object (host). -async Perform asynchronous operation. set Operation that can be performed are modify name, modify description, remove initiator(s) from host, add initiator(s) to host, update existing initiator(s) with chap username/password. This will only support one of add, remove and update initiator operations in a single request. Format host {-id | -name } set [-name ] [-description ] [remove_initiators ,.
Protocol type of the host initiator. iSCSI An iSCSI initiator. FC A Fibre Channel initiator. -chap_single_username Username for CHAP authentication. This value must be 1 to 64 UTF-8 characters. CHAP username is required when the cluster CHAP mode is mutual authentication. -chap_single_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 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 printable UTF-8 characters. 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. -async Perform asynchronous operation. attach Attach host to volume.
-id Unique id of the host. -name Unique name of the existing object (host). -volume_id Volume to detach. -async Perform asynchronous operation. host_group Manage host groups. A host group is a mechanism to provision hosts and volumes to be consistent across the Cyclone cluster. Operations that can be performed include, creating or deleting a host group, modifying host group(i.e. adding or removing hosts from a host group).
show Property capabilities Attribute Select Sort Search description 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 hosts.description X hosts.host_group_id X hosts.host_initiators X hosts.id X hosts.name X hosts.os_type X hosts.os_type_l10n X id X X X mapped_host_groups.host_group_id X mapped_host_groups.host_id X mapped_host_groups.
Format host_group [{-id | -name }] show [-select ,..] [-sort [+|],..] [-offset ] [{-limit | -all}] [-query ] [-output {nvp | csv [-table] [-noformat] | table | json [-raw]}] Action qualifiers -id Unique id of the host group. -name Unique name of the existing object (host_group). -select Display selected attributes in the output. -sort Sorts output field+ (or just field) sort by field in ascending order. fieldsort by field in descending order.
json Display output in JSON format. create Create a host group. Format host_group create -name -host_ids ,.. [-description ] [-async] Action qualifiers -name The host group 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 group. The description should not have any unprintable characters. -async Perform asynchronous operation. delete Delete a host group.
Format host_group {-id | -name } set [-name ] [-description ] [remove_host_ids ,..] [-add_host_ids ,..] [-async] Action qualifiers -id Unique id of the host group. -name Unique name of the existing object (host_group). -name A new host group 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 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. Format host_group {-id | -name } detach -volume_id [-async] Action qualifiers -id Unique id of the host group. -name Unique name of the existing object (host_group). -volume_id Volume to detach. -async Perform asynchronous operation. host_virtual_volume_mapping Virtual volume mapping details.
host_group_id Type: string Unique identifier of a host group attached to a virtual volume. The host_id and host_group_id cannot both be set. virtual_volume_id Type: string Unique identifier of the virtual volume to which the host is attached. 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_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.io_priority_l10n X virtual_volume.is_readonly X virtual_volume.location_history X virtual_volume.migration_session_id X virtual_volume.name X virtual_volume.
Attribute Select virtual_volume.type X virtual_volume.type_l10n X virtual_volume.usage_type X virtual_volume.usage_type_l10n X virtual_volume.virtual_machine_uuid X virtual_volume_id X Sort Search X X Format host_virtual_volume_mapping [-id ] show [-select ,..] [-sort [+|],..
-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_volume_mapping Storage cluster REST API definition. Details about a configured host or host group attached to a volume. The host or host group may not necessarily be connected.
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. See host_group for more details volume This is the embeddable reference form of volume_id attribute. See volume for more details show Property capabilities Attribute Select Sort Search host.description X host.host_group_id X host.host_initiators X host.id X host.name X host.
Attribute Select 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.node_affinity X volume.node_affinity_l10n X 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.
offset ] [{-limit | -all}] [-query ] [-output {nvp | csv [-table] [noformat] | table | json [-raw]}] Action qualifiers -id Unique identifier of the host volume mapping. -select Display selected attributes in the output. -sort Sorts output field+ (or just field) sort by field in ascending order. fieldsort by field in descending order. -offset Start record list starting from specific value. -limit Limits the number of listed records. -all Query all records.
vcenter Use this resource type to manage vCenter instances. Registered vCenter enables discovering of virtual machines, managing virtual machine snapshots, automatic mounting of storage container and other functionality that requires communication with vCenter. In Unified+ deployments, the one vCenter instance residing in the PowerStore cluster will be prepopulated here and cannot be deleted, nor may any other vCenters be added. For Unified deployments, one external vCenter may be configured if desired.
json [-raw]}] Action qualifiers -id Unique identifier of the vCenter to query. -select Display selected attributes in the output. -sort Sorts output field+ (or just field) sort by field in ascending order. fieldsort 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.
create Add a vCenter. Not allowed in Unified+ deployments. Format vcenter create [-address ] [-username ] [{-password | -passwordSecure}] [-async] Action qualifiers -address IP address of vCenter host, in IPv4, IPv6, or hostname format. -username User name to login to vCenter. -password Password to login to vCenter. -passwordSecure Secure version of -password. Value will be queried interactively. -async Perform asynchronous operation. delete Delete a registered vCenter.
Format vcenter -id set -passwordSecure}] [-async] [-address ] [-username ] [{-password | Action qualifiers -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.
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. memory_mb Type: 32-bit signed integer (0 to 2147483647) Memory size of the VM, in megabytes. Not applicable to VM snapshots.
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. is_consistent_snaps_supported Type: boolean Indicates whether the VM supports creating crash-consistent snapshots. Not applicable to snapshot VMs.
children This is the inverse of the resource type virtual_machine association. See virtual_machine for more details Attributes of protection_data created_by_rule_id Unique identifier of the protection rule that created the VM snapshot. created_by_rule_name Name of the rule that created the VM snapshot. This value is not updated if the name of the rule changes after snapshot creation. creator_type Creator type of the storage resource. * User - A resource created by a user.
Attribute Select Sort Search 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.
Attribute Select 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.vcenter_instance_uuid X protection_data X protection_policy.description X protection_policy.id X protection_policy.
Attribute Select Sort Search 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_instance_uuid X X X Format virtual_machine [{-id | -name }] show [-select ,..] [-sort [+|-],..
-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. 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 } set [-protection_policy_id ] [-async] Action qualifiers -id Unique identifier of the virtual machine to modify. -name Unique name of the existing object (virtual_machine). -protection_policy_id Unique identifier of the protection policy. -async Perform asynchronous operation. snapshot Create a snapshot of a virtual machine. This operation cannot be used on a virtual machine snapshot or template.
Migration Manage data import and data migration from remote systems import_host_initiator Use these resource types to manage import host initiators. Once import host is configured, host initiators can be queried and corresponding mapped volumes can be imported. Details about an import host initiator. Attributes id Type: string Unique identifier of the import host initiator. iqn_or_wwn Type: string iSCSI Qualified Name (IQN) or World Wide Name (WWN) of the host initiator.
Type: string Localized message string corresponding to protocol. show Property capabilities Attribute Select Sort Search id X X X import_host_system_id X X X iqn_or_wwn X X X protocol X X X protocol_l10n X X X Format import_host_initiator [-id ] show [-select ,..] [-sort [+|-],..
-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_host_system Use these resource types to manage import host systems. Import host enables communication with multipathing software on the host system to perform import operations.
EQL EQL MPIO. Native_MPIO Native MPIO. Power_Path POWER PATH MPIO. Unknown Type of host agent is unknown to PowerStore. agent_port Type: 32-bit signed integer (0 to 2147483647) TCP port on the import host system. agent_version Type: string Version of the import host system. agent_api_version Type: string API version of the import host system. os_type Type: enumerated value ("ESXi", "Linux", "Unknown", "Windows") Operating system of the import host system. Valid values are: Windows Windows. Linux Linux.
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. Conflict_Detected Agent detected that there are multiple MPIOs installed on the host and Destination Powerstore MPIO is not able to claim destination device as some other MPIO has already claimed it.
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.host_initiators X hosts.id X hosts.name X hosts.os_type X hosts.
Attribute Select Sort Search 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. -select Display selected attributes in the output. -sort Sorts output field+ (or just field) sort by field in ascending order.
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. If Host is already present, the same Host will be updated with the import_host_system details.
-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. -chap_single_passwordSecure Secure version of -chap_single_password.
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.
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 active_path_l10n X X X 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 ,..
-id Unique identifier of the import host volume to query. -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. fieldsort 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.
import_psgroup Use these resource types to discover the Peer Storage Group (PS Group) volumes that can be imported to PowerStore. PS Group details. This resource type has queriable association from import_psgroup_volume Attributes id Type: string 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.
supported_import_type Type: enumerated value ("Agentless", "Non_Disruptive_And_Agentless", "Not_Supported") Supported import types for the source storage system. Values are: Agentless The source array supports only agentless import. Non_Disruptive_And_Agentless The source array supports both nondisruptive and agentless import. Not_Supported The source array does not support import. supported_import_type_l10n Type: string Localized message string corresponding to supported_import_type.
Attribute Select Sort Search import_psgroup_volumes.importable_criteria_l10n X import_psgroup_volumes.is_online X import_psgroup_volumes.is_read_only X import_psgroup_volumes.migration_state X import_psgroup_volumes.migration_state_l10n X import_psgroup_volumes.name X import_psgroup_volumes.size X import_psgroup_volumes.
-select Display selected attributes in the output. -sort Sorts output field+ (or just field) sort by field in ascending order. fieldsort 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 identifier of the PS Group. -name Unique name of the existing object (import_psgroup). -async Perform asynchronous operation. import_psgroup_volume Use these resource types to discover the Peer Storage Group (PS Group) volumes that can be imported to PowerStore. PS Group volume instance details. This resource type has queriable association from import_psgroup Attributes id Type: string Unique identifier of the volume. is_online Type: boolean Indicates whether the volume is online.
512_Bytes 512 byte block size. 4K_Bytes 4096 byte block size. Unknown Block size cannot be determined. wwn Type: string Unique WWN of the volume. is_read_only Type: boolean Indicates whether the volume is read-only. migration_state Type: enumerated value ("Aborted", "Completed", "Disabled_For_IO", "In_Progress", "None", "Normal", "Prepared", "Unknown") Migration state of the volume. Valid values are: None Volume is not migrated. Normal Volume state is normal. Prepared Volume is prepared for migration.
importable_criteria Type: enumerated value "Host_Volume_Offline", ("Cluster_Node_Count_MisMatch", "Imported", "Incompatible_Host_Agent", "Replication_Destination", "In_Progress", "Ready", "SC_Degraded", "SC_Portable_Volume", "Ready_For_Agentless_Import", "SC_Live_Volume", "Undetermined", "Used_By_NAS", "VNX_Not_Ready", "XtremIO_State_Inappropriate", "SC_Not_Active", "Unity_System_Health_Inappropriate", "Unity_Volume_Health_Inappropriate", "VNX_Internal_Volume", "Incompatible_Firmware", "S
Attribute Select Sort Search 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.
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. -name Unique name of the existing object (import_psgroup_volume). -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. 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). -async Perform asynchronous operation.
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.
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.
Cancel_Failed Indicates that an attempt to cancel the import of a volume failed in a consistency group import. Cancel_In_Progress Indicates that a cancel is in progress. Cleanup_In_Progress Indicates that the import of one or more volumes in a consistency group failed. When this occurs, you must roll back the import of the other volumes of the consistency group by executing a Cancel operation on each volume. Cleanup_Failed Indicates that there was an error while cleaning up the consistency group.
cutover or if there is a failure, this value is null. average_transfer_rate Type: size (0 to 9223372036854775807 (8192.00P)) Average transfer rate of a data import operation in bytes/sec over the whole copy period. Before and after the import is in the Copy_In_Progress state, this value is null. current_transfer_rate Type: size (0 to 9223372036854775807 (8192.00P)) Current transfer rate of a data import operation in bytes/sec. Before and after the import is in the Copy_In_Progress state, this value is null.
type_l10n Type: string Localized message string corresponding to type. destination_resource_type_l10n Type: string Localized message string corresponding to destination_resource_type. state_l10n Type: string Localized message string corresponding to state. remote_system This is the embeddable reference form of remote_system_id attribute. See remote_system for more details Attributes of error code Hexadecimal error code for an import error. message_l10n Localized error message.
Attribute Select Sort Search 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.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.
Attribute Select Sort Search 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.
Unique name of the existing object (import_session). -select Display selected attributes in the output. -sort Sorts output field+ (or just field) sort by field in ascending order. fieldsort 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.
Format import_session create -remote_system_id -source_resource_id -name [description ] [-type {Non_Disruptive | Agentless}] [-host_ids ,..] ( [consistency_group_member_host_ids [-volume_wwn ] [{-host_ids ,.. | -host_names ,..}]]..
-host_names A list of names of existing objects (host). -volume_group_id Unique identifier of the volume group to which the imported volume will belong, if any. -automatic_cutover Indicates whether the import session cutover is manual (true) or automatic (false). -protection_policy_id Unique identifier of the protection policy that will be applied to an imported volume or consistency group after the import completes. Only snapshot policies are supported in an import.
Format import_session {-id | -name } set [-scheduled_timestamp ] [-async] Action qualifiers -id Unique identifier of the import session. -name Unique name of the existing object (import_session). -scheduled_timestamp Indicates the new date and time at which the import session is scheduled to run. The date is specified in ISO 8601 format with time expressed in UTC format. -async Perform asynchronous operation. cancel Cancel an active import session.
cleanup Clean up an import session that is in Cleanup_Required state and requires user intervention to revert the source volume to its pre-import state as part of the recovery procedure to restore host IO operations. Format import_session {-id | -name } cleanup [-async] Action qualifiers -id Unique identifier of the import session. -name Unique name of the existing object (import_session). -async Perform asynchronous operation.
of the import session after enabling the destination volume. To prevent accidental writes to the source volume through the source storage system path due to the incorrect reconfiguration, you can specify the removal of all host mappings of the source volume in the source storage system. Format import_session {-id | -name } enable_destination_volume [-async] Action qualifiers -id Unique identifier of the import session. -name Unique name of the existing object (import_session).
Action qualifiers -id Unique identifier of the import session -name Unique name of the existing object (import_session). -async Perform asynchronous operation. start_copy Start the background data copy operation to import data from the source volume. This action can only be used on an agentless import session that is in the 'Ready_To_Start_Copy' state after the host application is reconfigured and brought online to use the destination volume of the import session.
Name of the SC array. This property supports case-insensitive filtering. management_address Type: string Management address to use for communicating with the SC array. The address can be an IPv4 address, IPv6 address, or FQDN (Fully Qualified Domain Name). user_name Type: string User account name used to communicate with the SC array. model Type: string Model name of the SC array. serial_number Type: 32-bit signed integer (0 to 2147483647) Serial number of the SC array.
updated when the SC array is created and when the importable storage resources are discovered using the discover_importable_resources action. supported_import_type Type: enumerated value ("Agentless", "Non_Disruptive_And_Agentless", "Not_Supported") Supported import types for the source storage system. Values are: Agentless The source array supports only agentless import. Non_Disruptive_And_Agentless The source array supports both nondisruptive and agentless import.
Attribute import_storage_center_consistency_groups.import_storage_cent er_id import_storage_center_consistency_groups.importable_criteria import_storage_center_consistency_groups.importable_criteria_ l10n Select X X X import_storage_center_volumes.health X import_storage_center_volumes.health_l10n X import_storage_center_volumes.host_volume_ids X import_storage_center_volumes.id X ncy_group_id import_storage_center_volumes.
Attribute Select Sort Search import_storage_center_volumes.wwn X last_update_time X X X management_address X X X model X X X name X X X serial_number X X X status X X X status_l10n X X X supported_import_type X X X supported_import_type_l10n X X X user_name X X X Format import_storage_center [{-id | -name }] show [-select ,..] [-sort [+|-],..
fieldsort 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. discover Discover the importable volumes and snapshot profiles in the SC array.
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. name Type: string Name of the SC consistency group. This property supports case-insensitive filtering.
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.status X import_storage_center.status_l10n X import_storage_center.supported_import_type X import_storage_center.supported_import_type_l10n X import_storage_center.
Attribute Select Sort Search 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.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.
field+ (or just field) sort by field in ascending order. fieldsort 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.
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.
"Incompatible_Host_Agent", "Replication_Destination", "Ready", "SC_Degraded", "SC_Portable_Volume", "SC_Live_Volume", "Source_Volume_Offline", "Undetermined_Cluster_Type", "Used_By_NAS", "VNX_Not_Ready", "XtremIO_State_Inappropriate", "SC_Not_Active", "Undetermined", "Unity_System_Health_Inappropriate", "Unity_Volume_Health_Inappropriate", "VNX_Internal_Volume", "Ready_For_Agentless_Import", "VNX_Faulted", "XtremIO_Severity_Inappropriate", "XtremIO_Volume_Severity_Inappropriate", "XtremIO_Vo
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_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.
Attribute Select import_storage_center_consistency_group.importable_criteria_l 10n Sort Search X import_storage_center_consistency_group.
Display selected attributes in the output. -sort Sorts output field+ (or just field) sort by field in ascending order. fieldsort 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.
-id Unique identifier of the SC volume. -name Unique name of the existing object (import_storage_center_volume). -async Perform asynchronous operation. 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.
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.
the importable volumes and consistency groups are discovered. supported_import_type Type: enumerated value ("Agentless", "Non_Disruptive_And_Agentless", "Not_Supported") Supported import types for the source storage system. Values are: Agentless The source array supports only agentless import. Non_Disruptive_And_Agentless The source array supports both nondisruptive and agentless import. Not_Supported The source array does not support import.
Attribute Select import_unity_consistency_groups.id X import_unity_consistency_groups.import_unity_id X import_unity_consistency_groups.importable_criteria X import_unity_consistency_groups.importable_criteria_l10n X import_unity_consistency_groups.name X import_unity_volumes.health X import_unity_volumes.health_l10n X import_unity_volumes.host_volume_ids X import_unity_volumes.id X import_unity_volumes.import_unity_consistency_group_id X import_unity_volumes.
Attribute Select Sort Search import_unity_volumes.wwn X last_updated_timestamp X X X management_address X X X model X X X name X X X serial_number X X X software_version X X X supported_import_type X X X supported_import_type_l10n X X X user_name X X X Format import_unity [{-id | -name }] show [-select ,..] [-sort [+|],..
-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. discover Discover the importable volumes and consistency groups in the Unity storage system.
import_unity_consistency_group Use this resource type to discover the Unity consistency groups that can be imported to PowerStore. This resource type has queriable associations from import_unity_volume, import_unity Attributes id Type: string Unique identifier of the Unity consistency group. name Type: string Name of the consistency group. This property supports case-insensitive filtering. import_unity_id Type: string Unique identifier of the Unity storage system where the consistency group resides.
Attribute Select 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.software_version X import_unity.supported_import_type X import_unity.supported_import_type_l10n X import_unity.user_name X import_unity_id X import_unity_volumes.health X import_unity_volumes.
Attribute Select Sort Search 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+ (or just field) sort by field in ascending order. fieldsort 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.
-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. wwn Type: string World Wide Name (WWN) of the Unity volume. name Type: string Name of the Unity volume. This property supports case-insensitive filtering.
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. 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.
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.
host_volume_ids Type: array of strings 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.
Attribute Select Sort Search 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.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.
Attribute Select Sort Search is_replication_destination X X X 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 [+|-],..
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_snapshot_schedules Return the snapshot schedules associated with the specified Unity volume.
This resource type has queriable associations from import_vnx_volume, import_vnx_consistency_group Attributes id Type: string Unique identifier of the VNX storage system. 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).
Type: date time Timestamp at which the VNX storage system details were last updated. These details include information about the VNX storage system and its importable volumes and consistency groups. The timestamp is updated when the VNX storage system is created and when the importable storage resources are discovered using the discover action. software_version Type: string The software version of the block operating environment of the VNX storage system.
Attribute Select Sort Search import_vnx_consistency_groups.id X import_vnx_consistency_groups.import_vnx_array_id X import_vnx_consistency_groups.importable_criteria X import_vnx_consistency_groups.importable_criteria_l10n X import_vnx_consistency_groups.name X import_vnx_volumes.health X import_vnx_volumes.health_l10n X import_vnx_volumes.host_volume_ids X import_vnx_volumes.id X import_vnx_volumes.import_vnx_array_id X import_vnx_volumes.
Attribute Select Sort Search model X X X name X X X serial_number X X X software_version X X X supported_import_type X X X supported_import_type_l10n X X X user_name X X X Format import_vnx_array [{-id | -name }] show [-select ,..] [-sort [+|-],..] [-offset ] [{-limit | -all}] [-query ] [-output {nvp | csv [-table] [-noformat] | table | json [-raw]}] Action qualifiers -id Unique identifier of a VNX storage system.
-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. discover Discover the importable volumes and consistency groups in a VNX storage system. Format import_vnx_array {-id | -name } discover [-async] Action qualifiers -id Unique identifier of the VNX storage system.
id Type: string Unique identifier of the VNX consistency group. name Type: string Name of the consistency group. This property supports case-insensitive filtering. import_vnx_array_id Type: string Unique identifier of the VNX storage system where the consistency group exists.
Undetermined The import status cannot be determined due to an internal error. Contact technical support. importable_criteria_l10n Type: string Localized message string corresponding to importable_criteria. import_vnx_volumes This is the inverse of the resource type import_vnx_volume association. See attribute.
Attribute Select Sort Search import_vnx_array.user_name X import_vnx_array_id X X X import_vnx_volumes.health X import_vnx_volumes.health_l10n X import_vnx_volumes.host_volume_ids X 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.
-id Unique identifier of a VNX consistency group. -name Unique name of the existing object (import_vnx_consistency_group). -select Display selected attributes in the output. -sort Sorts output field+ (or just field) sort by field in ascending order. fieldsort 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.
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. name Type: string Name of the VNX volume. This property supports case-insensitive filtering. wwn Type: string World wide name of the VNX volume. size Type: size (0 to 9223372036854775807 (8192.00P)) Size of the VNX volume in bytes.
migration state cannot be determined. import_vnx_array_id Type: string Unique identifier of the VNX storage system where the volume exists. import_vnx_consistency_group_id Type: string Unique identifier of the VNX consistency group, if the volume is in a consistency group.
support. Host_Volume_Offline The host volume is offline. Cluster_Node_Count_MisMatch The host or hosts added to the appliance are not part of the host cluster to which the volume is mapped. Undetermined_Cluster_Type The system cannot determine the host cluster type. Source_Volume_Offline The source volume is offline. Replication_Destination The volume is a replication destination. SC_Live_Volume The volume is a Storage Center Live Volume. SC_Degraded The volume is not available or is in a degraded state.
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. XtremIO_Volume_Severity_Inappropriate The severity level XtremIO volume is not suitable for import. XtremIO_Volume_State_Inappropriate The state of the XtremIO volume is not suitable for import. host_volume_ids Type: array of strings List of host volume identifiers associated with the VNX volume.
Attribute Select Sort Search host_volume_ids X X X id X X X import_vnx_array.alternate_management_address X import_vnx_array.id X 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.
Attribute Select Sort Search importable_criteria X X X importable_criteria_l10n X X X 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_vnx_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 VNX volume.
-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_xtremio Use these resource types to discover the XtremIO volumes and consistency groups that can be imported to PowerStore.
Serial number of the XtremIO storage system. cluster_guid Type: string Cluster GUID of the XtremIO storage system. platform Type: enumerated value ("X1", "X2") XtremIO hardware platform. Values are: X1 X1 hardware platform. X2 X2 hardware platform. software_version Type: string Software version of the XtremIO storage system. xms_version Type: string Version of the XMS instance that manages the 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. Stopping XtremIO system is executing a stop command. Stopped XtremIO system is in stopped state. Starting XtremeIO system is starting. Failed XtremIO system is in failed state. Down XtremIO system is down. Stop_Failed Stop command failed on the XtremIO system. Attempting_To_Start XtremIO is in attempting to start sate.
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 entity and all contained/members is Critical. * Unknown The severity is unknown to PowerStore. user_name Type: string User account name used to communicate with the XtremIO storage system. last_updated_timestamp Type: date time Date and time when the XtremIO storage system details were last updated.
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.importable_criteria X import_xtremio_consistency_groups.importable_criteria_l10n X import_xtremio_consistency_groups.name X import_xtremio_volumes.certainty X import_xtremio_volumes.certainty_l10n X import_xtremio_volumes.
Attribute Select Sort Search import_xtremio_volumes.severity X import_xtremio_volumes.severity_l10n X import_xtremio_volumes.size X import_xtremio_volumes.
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. -sort Sorts output field+ (or just field) sort by field in ascending order. fieldsort 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.
discover Discover the importable volumes and consistency groups in the XtremIO storage system. 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. import_xtremio_consistency_group Use these resource types to discover the XtremIO volumes and consistency groups that can be imported to PowerStore.
importable_criteria_l10n Type: string Localized message string corresponding to importable_criteria. import_xtremio_volumes This is the inverse of the resource type import_xtremio_volume association. See import_xtremio_volume for more details import_xtremio This is the embeddable reference form of import_xtremio_id attribute. See import_xtremio for more details show Property capabilities Attribute Select Sort Search id X X X import_xtremio.cluster_guid X import_xtremio.id X import_xtremio.
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).
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 XtremIO consistency group. Format import_xtremio_consistency_group {-id | -name } import_snapshot_schedules [async] Action qualifiers -id Unique identifier of the XtremIO consistency group. -name Unique name of the existing object (import_xtremio_consistency_group).
name Type: string Name of the XtremIO volume. This property supports case-insensitive filtering. size Type: size (0 to 9223372036854775807 (8192.00P)) Size of the XtremIO volume, in bytes. severity 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.
XMS is uncertain whether a remove request was executed on XtremIO storage system. Unknown The certainty is unknown to PowerStore. 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.
consistency group. severity_l10n Type: string Localized message string corresponding to severity. certainty_l10n Type: string Localized message string corresponding to certainty. importable_criteria_l10n Type: string Localized message string corresponding to importable_criteria. import_xtremio 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.
-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 XtremIO volume.
id Type: string Unique ID of recommendation. created_timestamp Type: date time Time at which recommendation was created. state Type: enumerated value ("Migration_Error", "Migration_Paused", "Migration_Session_Create_Failed", "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. 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. type Type: enumerated value ("Evacuate_Appliance") Type of request that generated a migration recommendation.
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 Attributes of migration_actions resource_id ID of storage resource migrated by this action. resource_type Storage resource types eligible for migration.
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. Migration_Start_Failed The migration session for this recommended action failed to start. Migration_Paused The migration session for this recommended action is paused. Migration_Error The migration session for this recommended action has failed.
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. No_Virtual_Machine_Attached Resource is not attached to any virtual machine. Attached_To_Host Resource is attached to host. Attached_To_Virtual_Machine Resource is attached to virtual machine. Volume_Group_Member Resource is a member of volume group.
appliance and space_to_free is not specified, error will be returned. To free up desired amount of space from an appliance, specify the amount of space greater than zero to be freed. target_appliance_ids Optional IDs of appliances to which used storage can be migrated for this request. If no target appliances are specified, the evacuated objects can be placed on any appliance in the cluster.
-id Unique ID of the migration recommendation. -select Display selected attributes in the output. -sort Sorts output field+ (or just field) sort by field in ascending order. fieldsort 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.
Format migration_recommendation create -evacuate_appliance -appliance_id [-space_to_free <1 .. 9223372036854775807 (8192.00P)>] [-target_appliance_ids ,..] [-async] Action qualifiers -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.
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. start_migration_sessions Start previously created migration sessions for recommendation.
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.
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. System_Paused Migration session transitions to this state if it encounters any error. User may resume or delete the migration session after resolving the error.
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 replication_sessions.id X replication_sessions.last_sync_timestamp X replication_sessions.local_resource_id X replication_sessions.progress_percentage X replication_sessions.remote_resource_id X 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.
Attribute Select 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.size X virtual_volumes.source_id X virtual_volumes.
Attribute Select 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.protection_policy_id X volume_groups.type X volume_groups.
Attribute Select volumes.migration_session_id X volumes.name X volumes.node_affinity X volumes.node_affinity_l10n 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.wwn X Sort Search Format migration_session [{-id | -name }] show [-select ,..] [-sort [+|-],..
field+ (or just field) sort by field in ascending order. fieldsort 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 migration session.
-resource_type Storage resource types eligible for migration. -family_id Family identifier designating the storage resource or resources to migrate. For volume or virtual_volume migrations, the family is moved together because they share data among the primary object, snapshots, and clones. For volume_group migration, the family of each volume in the group is moved because it is a grouping of volumes. -destination_appliance_id Unique identifier of the destination appliance instance.
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. -name Unique name of the existing object (migration_session). -async Perform asynchronous operation. pause Pause a migration session. Only migration sessions in the synchronizing state can be paused.
-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. Sync can be run multiple times to reduce the amount of data that must be copied during the cutover.
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.
resource_id Type: string Unique identifier of the resource instance which generated this alert. resource_name Type: string Name of the resource instance which generated this alert. This property supports caseinsensitive filtering. description_l10n Type: string Latest event’s description text for this alert. generated_timestamp Type: date time Timestamp of the latest event for this alert. state Type: enumerated value ("ACTIVE", "CLEARED") Alert State Enum with values - Active and Cleared.
Timestamp when the email was sent for the raised alert, if any. acknowledged_timestamp Type: date time Timestamp when the alert was acknowledged, if any. events Type: array of objects List of events associated with this alert. Filtering on the fields of this embedded resource is not supported. See events for more details severity_l10n Type: string Localized message string corresponding to severity. resource_type_l10n Type: string Localized message string corresponding to resource_type.
insensitive filtering generated_timestamp Timestamp at which this event occured. description_l10n Description of this event. system_impact_l10n Describes the possible effect on the system of this event. repair_flow_l10n Suggestions for how to resolve any problems that may arise from this event.
Attribute Select Sort Search 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 state X X X state_l10n X X X Format alert [-id ] show [-select ,..] [-sort [+|-],..] [-offset ] [{-limit | -all}] [-query ] [-output {nvp | csv [-table] [-noformat] | table | json [-raw]}] Action qualifiers -id Unique identifier of the alert.
-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. acknowledged_severity parameter, if included, will cause the request to fail when the alert’s severity is higher than the acknowledged_severity parameter value.
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. Attributes id Type: string Unique identifier of this occurrence of an event. event_code Type: string Identifies the specific kind of event that has occurred.
resource_id Type: string Unique identifier of the resource instance which generated this event. resource_name Type: string Name of the resource instance which generated this event. This property supports caseinsensitive filtering. generated_timestamp Type: date time Timestamp at which this event occured. description_l10n Type: string Description of this event. system_impact_l10n Type: string Describes the possible effect on the system of this event.
Attribute Select Sort Search generated_timestamp X X X id X X X repair_flow_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 severity X X X severity_l10n X X X system_impact_l10n X X X Format event [-id ] show [-select ,..] [-sort [+|-],..
-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. job Use this resource type for tracking an operation’s progress and status. Information about the job.
resource_type Type: enumerated value ("alert", "appliance", "audit_event", "bond", "chap_config", "cluster", "cma_user_preference", "email_notify_destination", "file_interface", "file_nis", "file_interface_route", "file_system", "hardware", "eth_port", "discovered_initiator", "event", "file_kerberos", "file_tree_quota", "host", "fc_port", "file_dns", "file_ldap", "file_user_quota", "host_group", "dns", "file_ftp", "file_ndmp", "file_virus_checker", "host_virtual_volume_mapping", "host_vo
has not completed clean up * UNRECOVERABLE_FAILED - Job failed, and couldn’t complete its clean up steps, leaving the system inconsistent * FAILED - Job failed, and completed its clean up. start_time Type: date time Date and time when the job execution started. phase Type: enumerated value ("Completed", "Failed", "Failing", "In_Progress", "Pending", "Queued", "Skipped", "Unrecoverable_Failed") Current status of the job.
response_body Type: object Base response object Filtering on the fields of this embedded resource is not supported.
resource_type_l10n Type: string Localized message string corresponding to resource_type. state_l10n Type: string Localized message string corresponding to state. phase_l10n Type: string Localized message string corresponding to phase. parent This is the embeddable reference form of parent_id attribute. See job for more details children This is the inverse of the resource type job association. See job for more details root This is the embeddable reference form of root_id attribute.
forecast does not reach full capacity before it ends. In this case the end of the forecast can be used as a minimum for time to full. time_to_full Estimated date-time at which the forecast value will reach full capacity. 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.
Attributes of job_cluster_time_to_full_response cluster_id Unique ID of the cluster. end_of_forecast Timestamp of the end of the capacity forecast. If time to full estimates are null, the relevant forecast does not reach full capacity before it ends. In this case the end of the forecast can be used as a minimum for time to full. time_to_full Estimated date-time at which the forecast value will reach full capacity.
messages See messages for more details Attributes of job_file_system_clone_response id The id of the created clone. Attributes of job_file_system_restore_response id The id of the created snapshot. Attributes of job_file_system_snapshot_response id The id of the created snapshot. Attributes of job_job_response id The id of the job created by the request.
Attributes of job_virtual_machine_snapshot_response id Unique id of the new snapshot. Attributes of job_volume_clone_response id Attributes of job_volume_group_clone_response id Unique identifier of the new instance created. 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.
error_code description 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. 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.
Attribute Select Sort Search children.resource_name X children.resource_type X children.resource_type_l10n X children.response_body 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.
Attribute Select leafs.progress_percentage X 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.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.phase X parent.
Attribute Select Sort Search 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.root_id X parent.start_time X parent.state X parent.state_l10n X parent.step_order X parent.
Attribute Select Sort Search resource_name X X X resource_type X X X resource_type_l10n X X X response_body 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.resource_id X root.resource_name X root.resource_type X root.resource_type_l10n X root.response_body X root.root_id X root.
Attribute Select Sort Search root.state X root.state_l10n X root.step_order X root.user X root_id X X X start_time X X X state X X X state_l10n X X X step_order X X X user X X X Format job [-id ] show [-select ,..] [-sort [+|-],..] [-offset ] [{limit | -all}] [-query ] [-output {nvp | csv [-table] [-noformat] | table | json [-raw]}] Action qualifiers -id Unique id of the job.
-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. metrics REST APIs Use these resource types to query historical metric data. generate Retrieves metrics for specified type.
Action qualifiers -entity An enum describing the various entities supported by metrics. performance_metrics_by_appliance Appliance performance metrics. performance_metrics_by_node Node performance metrics. performance_metrics_by_volume Volume performance metrics. performance_metrics_by_cluster Cluster performance metrics. performance_metrics_by_vm Virtual Machine performance metrics.
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 Copy metrics for each volume group copy_metrics_by_remote_system Copy metrics for each remote system copy_metrics_by_volume Copy metrics for each volume performance_metrics_by_file_system Perform
Performance metrics for the SMB2 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 protocol performance_metrics_nfsv4_by_node Performance metrics for the NFSv4 protocol -entity_id Identifier for specific entity. -interval Intervals of which metrics can be provided. -output Change the output format. nvp Display output as plain text. csv Display output in CSV format.
id Type: string Unique identifier of the policy. name Type: string Policy name. This property supports case-insensitive filtering. description Type: string Policy description. type Type: enumerated value ("Performance", "Protection") Supported policy types. Protection A protection policy, consisting of snapshot and replication rules. Performance A performance policy, consisting of performance rules.
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. See performance_rule for more details snapshot_rules List of the snapshot_rules that are associated with this policy. See snapshot_rule for more details replication_rules List of the replication_rules that are associated with this policy.
Attribute Select 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.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.
Attribute Select Sort Search 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.alert_threshold X replication_rules.id X replication_rules.is_replica X replication_rules.name X replication_rules.
Attribute Select Sort Search 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 type X X X type_l10n 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.
Attribute Select virtual_machines.type X virtual_machines.type_l10n 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.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.
Attribute Select volumes.id X volumes.is_replication_destination X volumes.location_history X volumes.migration_session_id X volumes.name X volumes.node_affinity X volumes.node_affinity_l10n 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.wwn X Sort Search Format policy [{-id | -name }] show [-select ,..
Unique name of the existing object (policy). -select Display selected attributes in the output. -sort Sorts output field+ (or just field) sort by field in ascending order. fieldsort 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.
• If the policy is associated with a replication rule, a replication session is created and synchronized based on the schedule specified in the replication rule. Format policy create -name [-description replication_rule_ids ,..] [-async] ] [-snapshot_rule_ids ,..] [- Action qualifiers -name Policy name. -description Policy description. -snapshot_rule_ids Snapshot rule identifiers included in this policy.
Format policy {-id | -name } set [-name ] [-description ] [snapshot_rule_ids ,..] [-replication_rule_ids ,..] [-add_snapshot_rule_ids ,..] [-add_replication_rule_ids ,..] [-remove_snapshot_rule_ids ,..] [remove_replication_rule_ids ,..] [-async] Action qualifiers -id Unique identifier of the policy to be modified. -name Unique name of the existing object (policy). -name Policy name. -description Policy description.
specifies the remote system to use as the destination for the replication session. The PowerStore local system can establish a remote system relationship with different types of remote storage systems for replication remote protection and import use-cases. Refer to the RemoteSystemTypeEnum specification for a list of system types supported.
Username used to access the non-PowerStore remote systems. state Type: enumerated value ("Management_Connection_Lost", "OK", "Update_Needed") Current state of the remote system. data_connection_state Type: enumerated value ("Complete_Data_Connection_Loss", "No_Targets_Discovered", "OK", "Initializing", "Partial_Data_Connection_Loss", "Status_Not_Available") State of the data connection. iscsi_addresses Type: array of strings iSCSI target addresses for the data connection to the remote system.
Localized message string corresponding to state. data_connection_state_l10n Type: string Localized message string corresponding to data_connection_state. discovery_chap_mode_l10n Type: string Localized message string corresponding to discovery_chap_mode. session_chap_mode_l10n Type: string Localized message string corresponding to session_chap_mode. data_network_latency_l10n Type: string Localized message string corresponding to data_network_latency.
show Property capabilities Attribute Select Sort Search data_connection_state X X X data_connection_state_l10n X X X data_connections X X X data_network_latency X X X data_network_latency_l10n X X X description X X X discovery_chap_mode X X X discovery_chap_mode_l10n X X X id X X X import_sessions.automatic_cutover X import_sessions.average_transfer_rate X import_sessions.current_transfer_rate X import_sessions.description X import_sessions.
Attribute Select Sort Search import_sessions.name X import_sessions.parent_session_id X import_sessions.progress_percentage X import_sessions.protection_policy_id X import_sessions.remote_system_id X import_sessions.scheduled_timestamp X import_sessions.source_resource_id X import_sessions.state X import_sessions.state_l10n X import_sessions.type X import_sessions.type_l10n X import_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.
-name Unique name of the existing object (remote_system). -select Display selected attributes in the output. -sort Sorts output field+ (or just field) sort by field in ascending order. fieldsort 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.
Management address Either an IPv4 or IPv6 address. FQDN is not supported. • Type of remote system • Data network latency type For PowerStore remote system relationships, the relationship is created in both directions. Remote protection policies can be configured using the PowerStore remote system instance on either of the systems. This enables remote replication for storage resources in either direction.
PowerStore remote systems. Both IPv4 and IPv6 are supported for PowerStore remote systems. -name User-specified name of the remote system. Used only for non-PowerStore systems. This value must contain 128 or fewer printable Unicode characters. -description User-specified description of the remote system. -type Type of 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.
-target_discovery_passwordSecure Secure version of -target_discovery_password. Value will be queried interactively. -initiator_session_username Username used by the initiator to authenticate the target during session authentication. Mutual CHAP mode only. -initiator_session_password Password used by the initiator to authenticate the target during session authentication. Mutual CHAP mode only. -initiator_session_passwordSecure Secure version of -initiator_session_password.
connectivity between the local and remore systems. Only the local end of the relationship is deleted. Manually log in to the remote PowerStore system and remove the relationship. Format remote_system {-id | -name } delete [-async] Action qualifiers -id Unique identifier of the remote system. -name Unique name of the existing object (remote_system). -async Perform asynchronous operation. set Modify a remote system instance. The list of valid parameters depends on the type of remote system.
-remote_passwordSecure}] [-data_network_latency {Low | High}] [-async] Action qualifiers -id Unique identifier of the remote system. -name Unique name of the existing object (remote_system). -name User-specified name of the remote system. Used only for non-PowerStore type remote systems. This value must contain 128 or fewer printable Unicode characters. -description User-specified description of the remote system. -management_address Management IP address of the remote system.
-id Unique identifier of the remote system. -name Unique name of the existing object (remote_system). -async Perform asynchronous operation. replication_rule Use this resource type to manage the replication rules that are used in protection policies. Properties of the replication rule. This resource type has queriable associations from policy, replication_session Attributes id Type: string Unique identifier of the replication rule. name Type: string Name of the replication rule.
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. rpo_l10n Type: string Localized message string corresponding to rpo. replication_sessions This is the inverse of the resource type replication_session association.
Attribute Select Sort Search replication_sessions.id X replication_sessions.last_sync_timestamp X replication_sessions.local_resource_id X replication_sessions.progress_percentage X replication_sessions.remote_resource_id X 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.
Unique name of the existing object (replication_rule). -select Display selected attributes in the output. -sort Sorts output field+ (or just field) sort by field in ascending order. fieldsort 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.
<0..1440>] [-async] Action qualifiers -name Name of the replication rule. -rpo 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. -remote_system_id Unique identifier of the remote system to which this rule will replicate the associated resources. -alert_threshold Acceptable delay in minutes between the expected and actual replication sync intervals.
If the rule is associated with a policy that is currently applied to a storage resource, the modified rule is immediately applied to the associated storage resource. Changing the remote_system_id is not permitted, if the rule is part of a policy that is currently applied to a storage resource.
replication_session Use this resource type to manage replication sessions for storage resources in the system. Replication sessions operate on volume and volume_group resource types. Replication sessions are created and deleted through protection policies on the storage resources. In addition to copying data, the replication session synchronizes configuration changes on source resource and replicates user and scheduled snapshots to destination system.
resource_type Type: enumerated value ("volume", "volume_group") Type of the storage resource. last_sync_timestamp Type: date time Time of last successful synchronization. local_resource_id Type: string Unique identifier of the local storage resource for the replication session. remote_resource_id Type: string Unique identifier of the remote storage resource for the replication session. remote_system_id Type: string Unique identifier of the remote system instance.
Filtering on the fields of this embedded resource is not supported. See storage_element_pairs for more details 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 id 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.name X migration_session.
Attribute Select 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.name X remote_system.serial_number X remote_system.session_chap_mode X remote_system.
Attribute Select Sort Search 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.rpo_l10n X replication_rule_id X X X resource_type X X X resource_type_l10n X X X role X X X role_l10n X X X state X X X state_l10n X X X storage_element_pairs X X X Format replication_session [-id ] show [-select ,..] [-sort [+|-],..
field+ (or just field) sort by field in ascending order. fieldsort 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. failover Fail over a replication session instance.
• 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. You can use the reprotect action to synchronize the destination storage resource, and then resume the replication session. The auto-reprotect feature can also be used after a planned failover by using the reverse parameter, which activates the session in the reverse direction.
pause Pause a replication session instance. You can pause a replication session when you need to modify the source or destination system. For example, you can pause the replication session to take the source or destination system down for maintenance.
Format replication_session -id pause [-async] Action qualifiers -id Unique identifier of the replication session. -async Perform asynchronous operation. reprotect Reprotect a replication session instance. Activates the replication session and starts synchronization. This can only be used when the session is in the has been failed over. Format replication_session -id reprotect [-async] Action qualifiers -id Unique identifier of the replication session.
Action qualifiers -id Unique identifier of the replication session. -async Perform asynchronous operation. sync Synchronize the destination resource with changes on source resource from the previous synchronization cycle. Synchronization happens either automatically according to a set schedule, or manually. User and scheduler-created snapshots are synchronized from the source system to the destination system while maintaining block sharing efficiency.
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.
interval_l10n Type: string Localized message string corresponding to interval. 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.
Attribute Select Sort Search time_of_day 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.
csv Display output in CSV format. 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 ] [-days_of_week {Monday | Tuesday | Wednesday | Thursday | Friday | Saturday | Sunday},..
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). -delete_snaps Specify whether all snapshots previously created by this rule should also be deleted when this rule is removed. -async Perform asynchronous operation. set Modify a snapshot rule.
-time_of_day Time of the day to take a daily snapshot, with format "hh:mm" in 24 hour time format. Either the interval parameter or the time_of_day parameter may be set, but not both. -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. -desired_retention Desired snapshot retention period in hours. The system will retain snapshots for this time period, if space is available. -async Perform asynchronous operation.
Config All the set operations on the system. Example: POST, PATCH, DELETE. System All the system level operations. Logout All the logging out events on the system. timestamp Type: date time Time the event occurred to one second precision. username Type: string Fully qualified name of the user who initiated the event to be audited. For example, domain_name/name. is_successful Type: boolean Whether the event was successful or not.
"file_nis", "file_system", "hardware", "file_tree_quota", "host", "file_user_quota", "host_group", "file_virus_checker", "host_virtual_volume_mapping", "host_volume_mapping", "import_host_initiator", "import_host_volume", "import_psgroup", "import_host_system", "import_psgroup_volume", "import_session", "import_storage_center", "import_storage_center_consistency_group", "import_unity", "import_storage_center_volume", "import_unity_consistency_group", "import_vnx_array", "import_unity_vol
Type: string Localized message string corresponding to type. resource_type_l10n Type: string Localized message string corresponding to resource_type. resource_action_l10n Type: string Localized message string corresponding to resource_action.
Attribute Select Sort Search type X X X type_l10n X X X username X X X Format audit_event show [-select ,..] [-sort [+|-],..] [-offset ] [{-limit | -all}] [-query ] [-output {nvp | csv [-table] [-noformat] | table | json [raw]}] Action qualifiers -select Display selected attributes in the output. -sort Sorts output field+ (or just field) sort by field in ascending order. fieldsort by field in descending order.
table Display output in a table. json Display output in JSON format. chap_config CHAP is enabled (or not) identically cluster-wide for all iSCSI targets. For both single and mutual CHAP authentication modes, the common username and password for all targets on the cluster are set here. For mutual mode, each initiator also has a CHAP username and password set. Changing the cluster CHAP mode disrupts all iSCSI connections, and will disable connections that are not completely and correctly configured.
Format chap_config [-id ] show [-select ,..] [-output {nvp | csv [-table] [-noformat] | table | json [-raw]}] Action qualifiers -id The id of the CHAP configuration object (always "0"). -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 CHAP configuration settings object.
CHAP is being used to authenticate the initiator Mutual CHAP is used to authenticate both the initiator and target -async Perform asynchronous operation. dns Manage DNS and NTP settings for the cluster. Attributes id Type: string Unique identifier of the DNS setting. addresses Type: array of strings DNS server addresses in IPv4 or IPv6 format. show Property capabilities Attribute Select Sort Search addresses X X X id X X X Format dns [-id ] show [-select ,..
-sort Sorts output field+ (or just field) sort by field in ascending order. fieldsort 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 a 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. Attributes id Type: string Unique identifier of the email notification destination. email_address Type: string Email address to receive notifications. notify_critical Type: boolean Whether to send notifications for critical alerts. notify_major Type: boolean Whether to send notifications for major alerts.
Attribute Select Sort Search email_address X X X id X X X notify_critical X X X notify_info X X X notify_major X X X notify_minor X X X Format email_notify_destination [-id ] show [-select ,..] [-sort [+|-],..] [-offset ] [{-limit | -all}] [-query ] [-output {nvp | csv [-table] [noformat] | table | json [-raw]}] Action qualifiers -id Unique identifier of the email notification destination.
-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.
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.
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. This resource type has queriable associations from network, ip_port, appliance, node Attributes id Type: string Unique identifier of the IP address.
IP address value, in IPv4 or IPv6 format. purposes Type: array of enumerated "ICM_Cluster_Floating", "Mgmt_Cluster_Floating", "SDNAS_Cluster_Floating", "Storage_Cluster_Floating", values ("ICD_Node", "ICM_Node_CoreOS", "ICM_Appliance_Floating", "Mgmt_Appliance_Floating", "Mgmt_Node_CoreOS", "SDNAS_Node", "Mgmt_Node_Host", "SDNAS_Node_Serviceability", "Storage_Global", "Storage_Iscsi_Initiator", "Storage_Iscsi_Target", "Unused", "VMotion") IP address purposes.
Attribute Select Sort Search 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.target_iqn X ip_port.veth_port_id X ip_port_id X X X network.gateway X network.id X network.ip_version X network.ip_version_l10n X network.mtu X network.prefix_length X network.type X network.
Attribute Select Sort Search network.vlan_id X network_id X X X node.appliance_id X node.id X node.slot X node_id X X X purposes X X X purposes_l10n X X X Format ip_pool_address [-id ] show [-select ,..] [-sort [+|-],..] [-offset ] [{-limit | -all}] [-query ] [-output {nvp | csv [-table] [-noformat] | table | json [-raw]}] Action qualifiers -id Unique identifier of a configured IP address.
-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. ip_port Use these resource types to manage the cluster-wide configuration of virtual IP ports, bonds, and virtual Ethernet ports.
of network scaling. If the IP port is not used by an iSCSI connection, this attribute should be empty. available_usages Type: array of enumerated values ("External_Replication", "ISCSI", "ISCSI_Default", "Management") Available IP port usages. current_usages Type: array of enumerated values ("External_Replication", "ISCSI", "ISCSI_Default", "Management") Current IP port usages. bond_id Type: string Unique identifier of the bond on top of which the IP port is configured.
partner This is the embeddable reference form of partner_id attribute. See ip_port for more details bond This is the embeddable reference form of bond_id attribute. See bond for more details eth_port This is the embeddable reference form of eth_port_id attribute. See eth_port for more details veth_port This is the embeddable reference form of veth_port_id attribute.
Attribute Select eth_port.current_speed X eth_port.current_speed_l10n X eth_port.hypervisor_port_id X eth_port.hypervisor_port_name X eth_port.hypervisor_vswitch_id X 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.
Attribute Select Sort Search eth_port.supported_speeds_l10n X eth_port_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.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.
Attribute Select Sort Search partner_id X X X target_iqn X X X 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.vswitch_name X veth_port.vswitch_port_group_name X veth_port.vswitch_port_id X veth_port.vswitch_port_name X veth_port_id X X X Format ip_port [-id ] show [-select ,..] [-sort [+|-],..
-sort Sorts output field+ (or just field) sort by field in ascending order. fieldsort 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.
Unique identifier of the IP port. -add_current_usages Usages to add to the current usages of an IP port. The current usages of an IP port can be extended with external replication if this usage is in the port’s list of available usages. The same settings will be applied to the partner IP port. 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.
Format keystore_archive [{-f | -d }] -filename download Action qualifiers -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.
Localized message string corresponding to type 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.
Display output in JSON format. create Create a new LDAP account. 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.
-async Perform asynchronous operation. set Modify the properties of an LDAP account. 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.
OpenLDAP Open source implementation of LDAP protocol Type of directory service protocol:\n LDAP Lightweight directory access protocol\n LDAPS Secure lightweight directory access protocol 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.
group_search_level Nested search level for performing group search.
Attribute Select protocol_l10n X user_id_attribute X 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.
group_member_attribute ] [-group_object_class ] [-group_search_level ] [-async] Action qualifiers -domain_name Name of the LDAP authority to construct the LDAP server configuration. -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.
-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. -user_id_attribute Name of the LDAP attribute whose value indicates the user ID. Default value is sAMAccountName. -user_object_class LDAP object class for users.
set Modify the properties of an LDAP domain. Format ldap_domain -id set [-ldap_servers ,..
-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. -user_id_attribute Name of the LDAP attribute whose value indicates the user ID. Default value is sAMAccountName.
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. If the system cannot reach the DellEMC Software Licensing Central, it will retry daily during the 30-day trial period.
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.
Format license upload [-license_file ] [-async] Action qualifiers -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.
Attribute Select is_locked X name X 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.
-name Name of the new local user 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. -password Password for the new local user account to be created. The password value can be 8 to 40 UTF-8 characters long, and include as a minimum one uppercase character, one lowercase character, one numeric character, and one special character from this list [!,@#$%^*>_~].
current_password | -current_passwordSecure}] [{-password | -passwordSecure}] [async] Action qualifiers -id Unique identifier of the local user account to be modified. -role_id The unique identifier of the new role to which the local user has to 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.
user Fully qualified user account name being used to log in. role_ids Roles to which the logged-in user is mapped. idle_timeout Remaining idle time until the session will expire, in seconds. is_password_change_required Indicates whether the logged-in user requires a password change. is_built_in_user Indicates whether the logged-in user is predefined.
csv Display output in CSV format. table Display output in a table. json Display output in JSON format. network Use these resource types to scale and reconfigure the IP networks in a cluster. This resource type has queriable association from ip_pool_address 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.
Type: 32-bit signed integer (0 to 4094) VLAN identifier. 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.
Attribute Select Sort Search ip_pool_addresses.ip_port_id X ip_pool_addresses.network_id X ip_pool_addresses.node_id X ip_pool_addresses.purposes X ip_pool_addresses.purposes_l10n X ip_version X X X ip_version_l10n X X X mtu X X X prefix_length X X X type X X X type_l10n X X X vlan_id X X X Format network [-id ] show [-select ,..] [-sort [+|-],..
fieldsort 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 network parameters, such as gateways, netmasks, VLAN identifiers, and IP addresses.
-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. 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.
-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.
-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. -dns_addresses List of new DNS server IP addresses in IPv4 or IPv6 format. -ntp_addresses List of new NTP server FQDNs or IP addresses in IPv4 or IPv6 format.
-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. -connect_method Physical switch connect method type. Valid values are: SSH Secure shell.
-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: - some of system network ports are in degraded state or have cabling issues, - system top-of-rack switches have configuration issues leading to network unreachability, - network IP addresses have duplicates in the network environment, - or network gateway is unreachable.
When force is true, the command will proceed instead. Caution: Only use this option when you are certain your requested settings are correct and you understand why they are failing at this time, and you want to apply the settings anyway. Improper network settings can make the system unreachable for data. -async Perform asynchronous operation. ntp Manage DNS and NTP settings for the cluster. Attributes id Type: string Unique identifier of the NTP setting.
-sort Sorts output field+ (or just field) sort by field in ascending order. fieldsort 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 NTP settings.
-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.username X id X X X name X X X purpose X X X purpose_l10n X X X Format physical_switch [{-id | -name }] show [-select ,..] [-sort [+|-],..
-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.
Management_Only Physical switch for management network only. -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. -ssh_password SSH password to connect a physical switch if SSH connect method is specified.
-name Unique name of the existing object (physical_switch). -async Perform asynchronous operation. 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}]]..
-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. -snmp_community_stringSecure Secure version of -snmp_community_string. Value will be queried interactively.
Attribute Select id X is_built_in X name X Sort Search Format role [-id ] show [-select ,..] [-output {nvp | csv [-table] [-noformat] | table | json [-raw]}] 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.
show Property capabilities Attribute Select id X idle_timeout X Sort Search Format security_config [-id ] show [-select ,..] [-output {nvp | csv [-table] [noformat] | table | json [-raw]}] Action qualifiers -id Unique identifier of the system security configuration. -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.
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. show Property capabilities Attribute Select Sort Search address X X X id X X X port X X X source_email X X X Format smtp_config [-id ] show [-select ,..] [-sort [+|-],..
fieldsort 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 Configure the outgoing SMTP information. Format smtp_config -id set [-address ] [-port <0..
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. Format smtp_config -id test [-email_address ] [-async] Action qualifiers -id Unique identifier of the SMTP configuration. -email_address Destination email address for the test. -async Perform asynchronous operation. software_installed Software upgrade functionality. Only one upgrade can be active at a time.
Type: string Version of the installed release software package release. 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. release_id Type: string Release ID of installed software used to determine if an appliance should be upgraded.
Attribute Select Sort Search release_timestamp X X X release_version X X X Format software_installed [-id ] show [-select ,..] [-sort [+|-],..] [offset ] [{-limit | -all}] [-query ] [-output {nvp | csv [-table] [noformat] | table | json [-raw]}] Action qualifiers -id Unique identifier of the installed software to query. -select Display selected attributes in the output. -sort Sorts output field+ (or just field) sort by field in ascending order.
Display output in CSV format. table Display output in a table. json Display output in JSON format. software_package Software upgrade functionality. Only one upgrade can be active at a time. A software package contains all of the content required to upgrade the cluster to the version specified in the release_version property. Attributes id Type: string Unique identifier of the software package. name Type: string Name of the software package. This property supports case-insensitive filtering.
Hotfix A package containing high priority firmware updates. Language_Pack A package containing additional language definitions. software_package_state Type: enumerated value ("Available", "Download_Failed", "Downloaded", "Install_Failed", "Installed", "Installing") Software package state. Valid values are: Available The package is ready to be downloaded. Downloaded The package is downloaded and ready to install. Installing The package is being installed.
installed_date Type: date time Date and time when this software package was successfully installed and committed on the cluster. If the software package has not been committed, this value is null. release_id Type: string Release ID of software package used to determine if an appliance should be upgraded. software_package_type_l10n Type: string Localized message string corresponding to software_package_type.
Attribute Select Sort Search 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] [-noformat] | table | json [-raw]}] Action qualifiers -id Unique identifier of the software package 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 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. Format software_package create [-upload_file ] [-async] Action qualifiers -upload_file Name of the software package file to upload.
-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.
-id Unique identifier of the software package. -name Unique name of the existing object (software_package). -async Perform asynchronous operation. x509_certificate Use these resource types to manage SSL/TLS certificates. The X509 Certificate service is part of the credential store services. An X509 Certificate in this service represents a certificate chain, composed of the certificate of each individual member in ordered sequence.
VASA provider service Import HTTP External web service 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. is_valid Indicates whether this is a valid X509 Certificate.
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.
-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 -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.
protocol to operate normally within an Active Directory domain. The DNS default port is 53. This resource type has queriable association from nas_server Attributes id Type: string Unique identifier of the DNS server. nas_server_id Type: string Unique identifier of the associated NAS Server instance that uses this DNS object. Only one DNS object per NAS Server is supported. domain Type: string Name of the DNS domain, where the NAS Server does host names lookup when an FQDN is not specified in the request.
show Property capabilities Attribute Select Sort Search domain X X X id X X X ip_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 transport X X X transport_l10n X X X Format file_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 object. -select Display selected attributes in the 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 DNS Server configuration for a NAS Server. Only one object can be created per NAS Server. Format file_dns create -nas_server_id -domain -ip_addresses ,.. [-transport {UDP | TCP}] [-async] Action qualifiers -nas_server_id Unique identifier of the associated NAS Server instance that uses this DNS object.
delete Delete DNS settings of a NAS Server. Format file_dns -id delete [-async] Action qualifiers -id Unique identifier of the DNS object. -async Perform asynchronous operation. set Modify the DNS settings of a NAS Server. Format file_dns -id set [-domain ] [-ip_addresses ,..] [-add_ip_addresses ,..] [-remove_ip_addresses ,..] [-transport {UDP | TCP}] [-async] Action qualifiers -id Unique identifier of the DNS object.
UDP DNS uses the UDP protocol (default) TCP DNS uses the TCP protocol -async Perform asynchronous operation. file_ftp Use these resources to configure one File Transfer Protocol (FTP) server per NAS server. One FTP server can be configured per NAS server to have both secure and unsecure services running. By default when an FTP server is created, the unsecure service will be running.
Indicates whether the SFTP server is enabled on the NAS server. Values are: - true - SFTP server is enabled on the specified NAS server. - false - SFTP server is disabled on the specified NAS server. is_smb_authentication_enabled Type: boolean Indicates whether FTP and SFTP clients can be authenticated using an SMB user name. These user names are defined in a Windows domain controller, and their formats are user@domain or domain\\user. Values are: - true - SMB user names are accepted for authentication.
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 Type: boolean 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 Type: string (Applies when the value of is_audit_enabled is true.) Directory of FTP/SFTP audit files.
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. is_allowed_hosts Type: boolean Indicates whether the hosts attribute contains allowed or denied hosts.
Attribute Select Sort Search 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.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_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.production_IPv6_interface_id X nas_server_id X X X users X X X welcome_message X X X Format file_ftp [-id ] show [-select ,..] [-sort [+|-],..
-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 FTP/SFTP server.
-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. - false - SFTP server is disabled on the specified NAS server.
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.) Maximum size of all (current plus archived) FTP/SFTP audit files, in bytes.
true - groups contains allowed user groups. - false - groups contains denied user groups. -async Perform asynchronous operation. delete Delete an FTP/SFTP Server. Format file_ftp -id delete [-async] Action qualifiers -id Unique identifier of the FTP/SFTP Server object. -async Perform asynchronous operation. set Modify an FTP/SFTP server settings.
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. - false - SFTP server is disabled on the specified NAS server. -is_smb_authentication_enabled Indicates whether FTP and SFTP clients can be authenticated using an SMB user name. These user names are defined in a Windows domain controller, and their formats are user@domain or domain\\user.
-audit_max_size (Applies when the value of is_audit_enabled is true.) Maximum size of all (current plus archived) FTP/SFTP audit files, in bytes. There is a maximum of 5 audit files, 1 current audit file (ftp.log) and 4 archived audit files. The maximum value for this setting is 5GB (each file of 1GB) if the audit directory belongs to a user file system of the NAS server. If the audit directory is '/', the maximum value is 5MB (each file of 1MB).
-add_groups Groups to add to the current groups. Error occurs if the group already exists. Cannot be combined with groups. -remove_groups Groups to remove from the current groups. Error occurs if the group is not present. Cannot be combined with groups. -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.
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. name Type: string Name of the network interface. This property supports case-insensitive filtering.
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.prefix_length X gateway X X X id X X X ip_address X X X is_disabled X X X name X X X nas_server.backup_IPv4_interface_id X nas_server.backup_IPv6_interface_id X nas_server.
Attribute Select Sort Search 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.
-select Display selected attributes in the output. -sort Sorts output field+ (or just field) sort by field in ascending order. fieldsort 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.
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. This resource type has queriable association from file_interface Attributes id Type: string Unique identifier of the file interface route.
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 3 route types Subnet, Default, and Host. • The default route establishes a static route to a default gateway. To create a default route, provide only the default gateway IP address. • The 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..
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. -select Display selected attributes in the 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 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 ,..
Format file_kerberos -id delete [-async] Action qualifiers -id Unique identifier of the Kerberos service 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.
upload_keytab A keytab file is required for secure NFS service with a Linux or Unix Kerberos Key Distribution Center (KDC). The keytab file can be generated using the KDC server. Format file_kerberos -id upload_keytab [-body ] [-async] 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.
Attributes id Type: string Unique identifier of the LDAP service object. nas_server_id Type: string Unique identifier of the associated NAS Server instance that uses this LDAP object. Only one 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.
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. protocol Type: enumerated value ("LDAP", "LDAPS") Indicates whether the LDAP protocol uses SSL for secure network communication. SSL encrypts data over the network and provides message and server authentication. LDAP LDAP protocol without SSL.
principal Type: string Specifies the principal name for Kerberos authentication. realm Type: string Specifies the realm name for Kerberos authentication. schema_type Type: enumerated value ("Microsoft", "RFC2307", "Unknown") LDAP server schema type. RFC2307 OpenLDAP/iPlanet schema. 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.
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 addresses X X X authentication_type X X X authentication_type_l10n X X X base_DN X X X bind_DN X X X 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.
Attribute Select Sort Search 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.
] [{-limit | -all}] [-query ] [-output {nvp | csv [-table] [-noformat] | table | json [-raw]}] Action qualifiers -id Unique identifier of the LDAP settings object. -select Display selected attributes in the output. -sort Sorts output field+ (or just field) sort by field in ascending order. fieldsort by field in descending order. -offset Start record list starting from specific value. -limit Limits the number of listed records. -all Query all records.
create Create an LDAP service on a NAS Server. Only one LDAP Service object can be created per NAS Server. Format file_ldap create -nas_server_id -authentication_type {Anonymous | Simple | Kerberos} -base_DN [-addresses ,..] [-port_number <0..
-protocol Indicates whether the LDAP protocol uses SSL for secure network communication. SSL encrypts data over the network and provides message and server authentication. 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.
-password The associated password for Kerberos authentication. -passwordSecure Secure version of -password. Value will be queried interactively. -async Perform asynchronous operation. delete Delete a NAS Server’s LDAP settings. Format file_ldap -id delete [-async] Action qualifiers -id LDAP settings object Id. -async Perform asynchronous operation. set Modify a NAS Server’s LDAP settings object.
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. 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.
true verifies LDAP server’s certificate. false doesn’t verify LDAP server’s certificate. -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.
Action qualifiers -id Unique identifier of the LDAP settings object. -async Perform asynchronous operation. upload_config Format file_ldap -id upload_config -body [-async] Action qualifiers -id Unique identifier of the LDAP settings object. -async Perform asynchronous operation.
-f Local path with the file name -d Local folder where file shall be stored -id Unique identifier of the LDAP settings object. file_ndmp The Network Data Management Protocol (NDMP) provides a standard for backing up file servers on a network. NDMP allows centralized applications to back up file servers that run on various platforms and platform versions.
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.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.description X nas_server.id X nas_server.
Attribute Select Sort Search user_name X X X Format file_ndmp [-id ] show [-select ,..] [-sort [+|-],..] [-offset ] [{-limit | -all}] [-query ] [-output {nvp | csv [-table] [-noformat] | table | json [-raw]}] Action qualifiers -id Unique identifier of the NDMP service object. -select Display selected attributes in the output. -sort Sorts output field+ (or just field) sort by field in ascending order. fieldsort by field in descending order.
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 create -nas_server_id -passwordSecure} [-async] -user_name {-password | Action qualifiers -nas_server_id Unique identifier of the NAS server to be configured with these NDMP settings. -user_name User name for accessing the NDMP service.
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. -passwordSecure Secure version of -password. Value will be queried interactively. -async Perform asynchronous operation.
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. See nas_server for more details show Property capabilities Attribute Select Sort Search domain X X X id X X X ip_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.
Attribute Select 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.production_IPv6_interface_id X nas_server_id X Sort Search X X Format file_nis [-id ] show [-select ,..] [-sort [+|-],..
-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. Only one NIS Setting object can be created per NAS Server. Format file_nis create -nas_server_id -domain -ip_addresses ,..
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. -domain Name of the NIS domain.
Attributes id Type: string File system id. name Type: string File system name. This property supports case-insensitive filtering. description Type: string File system description. nas_server_id Type: string Id of the NAS Server on which the file system is mounted. parent_id Type: string The object id of the parent of this file system (only applies to clones and snapshots). If the parent of a clone has been deleted the object_id will contain null.
Id 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. 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 Type: boolean 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_op_locks_enabled Type: boolean 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.
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. Values are: true Asynchronous MTIME is enabled on the file system. false Asynchronous MTIME is disabled on the file system.
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.
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. Snap_CLI Created inband by SnapCLI. AppSync Created by AppSync. filesystem_type_l10n Type: string Localized message string corresponding to filesystem_type.
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. See file_tree_quota for more details file_user_quotas This is the inverse of the resource type file_user_quota association.
Attribute Select Sort Search 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.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.soft_limit X file_tree_quotas.state X file_tree_quotas.state_l10n X file_user_quotas.
Attribute Select Sort Search 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 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.current_unix_directory_service_l10n X nas_server.default_unix_user X nas_server.
Attribute Select 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.min_security_l10n X nfs_exports.name X nfs_exports.nfs_owner_username X nfs_exports.
Attribute Select Sort Search 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.file_system_id X smb_shares.id X smb_shares.is_ABE_enabled X smb_shares.is_branch_cache_enabled X smb_shares.
Attribute Select 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 File system id. -name Unique name of the existing object (file_system). -select Display selected attributes in the output.
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.
false Change directory notifications are enabled. -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.
delete Delete a file system. Format file_system {-id | -name } delete [-async] Action qualifiers -id File system id. -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.
-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. -locking_policy File system locking policies. These policy choices control whether the NFSv4 range locks are honored.
false Synchronous writes option is disabled on the file system. -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.
Asynchronous MTIME is enabled on the file system. false Asynchronous MTIME is disabled on the file system. -protection_policy_id Id of the protection policy applied to the file system. -is_quota_enabled Indicates whether quota is enabled. Quotas are not supported for read-only file systems. Default value for the grace period is set to infinite=-1 to match Windows' quota policy Values are: true Start tracking usages for all users on a file system or a quota tree, and user quota limits will be enforced.
Format file_system {-id | -name } clone -name [-description ] [access_policy {Native | UNIX | Windows}] [-locking_policy {Advisory | Mandatory}] [folder_rename_policy {All_Allowed | SMB_Forbidden | All_Forbidden}] [is_smb_sync_writes_enabled {yes | true | no | false}] [-is_smb_no_notify_enabled {yes | true | no | false}] [-is_smb_op_locks_enabled {yes | true | no | false}] [is_smb_notify_on_access_enabled {yes | true | no | false}] [-is_smb_notify_on_write_enabled {yes | true |
-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.
false File system notifications are disabled on the file system. -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 file system.
refresh_quota Refresh the actual content of tree and user quotas objects. Format file_system {-id | -name } refresh_quota [-async] Action qualifiers -id File system id. -name Unique name of the existing object (file_system). -async Perform asynchronous operation. restore Restore from a snapshot of a file system. Format file_system {-id | -name } restore [-copy_name ] [-async] Action qualifiers -id File system snapshot id.
expiration_timestamp ] [-is_auto_delete_enabled {yes | true | no | false}] [-access_type {Snapshot | Protocol}] [-access_policy {Native | UNIX | Windows}] [-locking_policy {Advisory | Mandatory}] [-folder_rename_policy {All_Allowed | SMB_Forbidden | All_Forbidden}] [is_smb_sync_writes_enabled {yes | true | no | false}] [-is_smb_no_notify_enabled {yes | true | no | false}] [-is_smb_op_locks_enabled {yes | true | no | false}] [is_smb_notify_on_access_enabled {yes | true | no | false}] [-is_smb_notify_on
determines which mechanism is used to enforce file security on the particular file system. Native Native Security. 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.
-is_smb_no_notify_enabled Indicates whether notifications of changes to a directory file structure are enabled. true Change directory notifications are disabled. false Change directory notifications are enabled. -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.
-async Perform asynchronous operation. file_tree_quota Tree quota settings in the storage system. A tree quota instance represents a quota limit applied to a specific directory tree in a file system. This resource type has queriable associations from file_system, file_user_quota Attributes id Type: string Unique identifier of the tree quota. file_system_id Type: string Unique identifier of the associated file system. path Type: string Path relative to the root of the associated filesystem.
Soft_Exceeded_And_Expired Soft limit is exceeded, and grace period is expired. Hard_Reached Hard limit is reached. hard_limit Type: size (0 to 9223372036854775807 (8192.00P)) Hard limit of the tree quota, in bytes. No hard limit when set to 0. This value can be used to compute amount of space that is consumed without limiting the space. soft_limit Type: size (0 to 9223372036854775807 (8192.00P)) Soft limit of the tree quota, in bytes. No hard limit when set to 0.
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.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.
Attribute Select 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.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.
Attribute Select Sort Search file_user_tree_quotas.soft_limit X file_user_tree_quotas.state X file_user_tree_quotas.state_l10n X file_user_tree_quotas.tree_quota_id X file_user_tree_quotas.uid X file_user_tree_quotas.unix_name X file_user_tree_quotas.windows_name X file_user_tree_quotas.
-select Display selected attributes in the output. -sort Sorts output field+ (or just field) sort by field in ascending order. fieldsort 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.
Action qualifiers -file_system_id Unique identifier of the associated file system. -path Path relative to the root of the associated filesystem. -description Description of the tree quota. -hard_limit Hard limit of the tree quota, in bytes. No hard limit when set to 0. This value can be used to compute amount of space that is consumed without limiting the space. Value is always rounded up to match the physical block size of the filesystem. -soft_limit Soft limit of the tree quota, in bytes.
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}] [-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. This value can be used to compute amount of space that is consumed without limiting the space.
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. This resource type has queriable associations from file_system, file_tree_quota Attributes id Type: string Unique identifier of the user quota. file_system_id Type: string Unique identifier of the associated filesystem. tree_quota_id Type: string Unique identifier of the associated tree quota.
OK No quota limits are exceeded. Soft_Exceeded Soft limit is exceeded, and grace period is not expired. Soft_Exceeded_And_Expired Soft limit is exceeded, and grace period is expired. Hard_Reached Hard limit is reached. hard_limit Type: size (0 to 9223372036854775807 (8192.00P)) Hard limit of the user quota, in bytes. No hard limit when set to 0. This value can be used to compute amount of space that is consumed without limiting the space. soft_limit Type: size (0 to 9223372036854775807 (8192.
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.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.
Attribute Select Sort Search 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.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.
Attribute Select Sort Search 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.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.soft_limit X tree_quota.state X tree_quota.
Action qualifiers -id Unique identifier of the file user quota. -select Display selected attributes in the output. -sort Sorts output field+ (or just field) sort by field in ascending order. fieldsort 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.
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.00P)>] [-async] Action qualifiers -file_system_id Unique identifier of the filesystem in which the new user quota will be created. -tree_quota_id Unique identifier of the tree quota in which the new user quota will be created.
Format file_user_quota -id set [-hard_limit <0 .. 9223372036854775807 soft_limit <0 .. 9223372036854775807 (8192.00P)>] [-async] (8192.00P)>] [- Action qualifiers -id Unique identifier of the file user quota. -hard_limit Hard limit of the user quota, in bytes. No hard limit when set to 0. This value can be used to compute amount of space that is consumed without limiting the space. Value is rounded up to match the physical block size of the filesystem.
server. You can optionally set up the service to scan the file on read access based on last access of the file compared to last update of the third-party anti-virus date. This resource type has queriable association from nas_server Attributes id Type: string Unique identifier of the virus checker instance. nas_server_id Type: string NAS server that is configured with these anti-virus settings. is_enabled Type: boolean Indicates whether the anti-virus service is enabled on this NAS server.
Attribute Select 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.description X nas_server.id X nas_server.is_auto_user_mapping_enabled X nas_server.is_username_translation_enabled X nas_server.
Action qualifiers -id Unique identifier of the virus checker instance. -select Display selected attributes in the output. -sort Sorts output field+ (or just field) sort by field in ascending order. fieldsort 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.
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 create -nas_server_id [-async] Action qualifiers -nas_server_id Unique identifier of an associated NAS Server instance that uses this virus checker configuration.
-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. If third-party anti-virus servers are not available, according the policy, the access to the file systems is denied to prevent potential viruses propagation. - false - Anti-virus service is disabled.
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.
production_IPv4_interface_id Type: string 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.
nfs_servers This is the inverse of the resource type nfs_server association. See nfs_server for more details 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.
Attribute Select Sort Search default_unix_user X X X default_windows_user X X X 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.
Attribute Select file_ftps.is_homedir_limit_enabled X file_ftps.is_sftp_enabled X 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.
Attribute Select file_kerberoses.port_number X file_kerberoses.realm X 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.
Attribute Select file_ndmps.id X file_ndmps.nas_server_id X 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.
Attribute Select 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.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.
Attribute Select Sort Search file_systems.smb_notify_on_change_dir_depth X file_virus_checkers.id X 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.
Attribute Select Sort Search operational_status_l10n X X X preferred_node_id X X X 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.workgroup X Format nas_server [{-id | -name }] show [-select ,..
field+ (or just field) sort by field in ascending order. fieldsort 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.
-description Description of the 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.
NAS server is deleted. Values are:\n - true - Keep the associated SMB servers joined to the Active Directory when the NAS server is deleted. - false - (Default) Try to unjoin the associated SMB servers from the Active Directory before deleting the NAS server. -domain_user_name Administrator login used to unjoin the associated SMB servers from the Active Directory (AD) domain before deleting the NAS server.
-current_node_id Unique identifier of the node on which the NAS server is running. -preferred_node_id Unique identifier of the preferred node for the NAS server The initial value (on NAS server create) is taken from the current node. -current_unix_directory_service 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.
Format nas_server {-id | -name } ping [-destination_address ] [-is_ipv6 {yes | true | no | false}] [-async] Action qualifiers -id Unique identifier of the NAS server. -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.
nas_server/download group Download a NAS server group file containing the template or the actual (if already uploaded) group details. Format nas_server/download [{-f | -d }] {-id | -name } group 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).
hosts Download an NAS server host file containing template/actual(if already uploaded) host details. Format nas_server/download [{-f | -d }] {-id | -name } hosts 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).
Format nas_server/download [{-f | -d }] {-id | -name } nsswitch 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). ntxmap Download an NAS server ntxmap file containing the template or the actual (if already uploaded) ntxmap configuration settings.
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.
-id Unique identifier of the NAS server. -name Unique name of the existing object (nas_server). -body Upload NAS server group file. -async Perform asynchronous operation. 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.
-name Unique name of the existing object (nas_server). -body Upload NAS server host file. -async Perform asynchronous operation. netgroup Upload the NAS server netgroup file. Format nas_server/upload {-id | -name } netgroup [-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 netgroup file. -async Perform asynchronous operation. nsswitch Upload the NAS server nsswitch file.
Upload the NAS server nsswitch file. -async Perform asynchronous operation. ntxmap Format nas_server/upload {-id | -name } ntxmap [-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 ntxmap file. -async Perform asynchronous operation. passwd Upload NAS server passwd file.
nfs_export NFS Exports use the NFS protocol to provide an access point for configured Linux/Unix hosts or IP subnets to access file_systems or file_snapshots. This resource type has queriable association from file_system Attributes id Type: string Unique id of the NFS Export. file_system_id Type: string Unique identifier of the file system on which the NFS Export was created. name Type: string NFS Export name. This property supports case-insensitive filtering.
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 Type: enumerated value ("Kerberos", "Kerberos_With_Encryption", "Kerberos_With_Integrity", "Sys") 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.
Hosts can be entered by Hostname, IP addresses (IPv4, IPv6, IPv4/PrefixLength, IPv6/PrefixLenght, or IPv4/subnetmask), or Netgroups prefixed with @. read_write_hosts Type: array of strings Hosts with read and write 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 @.
Attribute Select Sort Search anonymous_GID X X X anonymous_UID X X X default_access X X X default_access_l10n X X X description X X X file_system.access_policy X file_system.access_policy_l10n X 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.
Attribute Select 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.last_writable_timestamp X file_system.locking_policy X file_system.
Attribute Select Sort Search id X X X is_no_SUID X X X min_security X X X min_security_l10n X X X name X X X nfs_owner_username X X X no_access_hosts X X X 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 [+|],..
field+ (or just field) sort by field in ascending order. fieldsort 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 an NFS Export for a Snapshot.
Unique identifier of the file system on which the NFS Export will be created. -path Local path to export relative to the file system root directory. With NFS, each export of a file_system or file_snap must have a unique local path. Before you can create additional Exports within an NFS shared folder, you must create directories within it from a Linux/Unix host that is connected to the file system.
-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 @. -read_only_root_hosts Hosts with read-only and ready-only 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 @.
-async Perform asynchronous operation. set Modify NFS Export Properties. Format nfs_export {-id | -name } set [-description ] [-default_access {No_Access | Read_Only | Read_Write | Root | Read_Only_Root}] [-min_security {Sys | Kerberos | Kerberos_With_Integrity | Kerberos_With_Encryption}] [-no_access_hosts ,..] [add_no_access_hosts ,..] [-remove_no_access_hosts ,..] [-read_only_hosts ,..] [-add_read_only_hosts ,..] [-remove_read_only_hosts ,.
integrity, or Kerberos with encryption. 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. -no_access_hosts Hosts with no access to the NFS export or its snapshots.
-add_read_only_root_hosts Hosts to add to the current read_only_root_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. Cannot combine with read_only_root_hosts. -remove_read_only_root_hosts Hosts to remove from the current read_only_root_hosts list.
-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. nfs_server Use these resource types to manage NFS servers. One NFS server may be configured per NAS server. At least one NFS share must be created from an NFS server before an NFS client can connect to the storage resources. NFS servers can support the NFSv3 and NFSv4 protocols. The default protocol is NFSv3.
accessed with NFSv4. When disabled, NFS shares cannot be accessed with NFSv4 protocol. true - NFSv4 is enabled on the specified NAS server. - false - NFSv4 is disabled on the specified NAS server. is_secure_enabled Type: boolean Indicates whether secure NFS is enabled on the NFS server. - true - Secure NFS is Enabled. false - Secure NFS is disabled. is_use_smb_config_enabled Type: boolean Indicates whether SMB authentication is used to authenticate to the KDC.
credentials cache. When failed mapping entries expire, the system retries mapping the UID to the SID. nas_server This is the embeddable reference form of nas_server_id attribute.
Attribute Select Sort Search 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+ (or just field) sort by field in ascending order. fieldsort 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 an 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. When disabled, NFS shares can not be accessed with NFSv3 protocol.
delete Delete an NFS server. Format nfs_server -id delete [-is_skip_unjoin {yes | true | no | false}] [-async] Action qualifiers -id Unique identifier of the NFS server. -is_skip_unjoin Allow to bypass NFS server unjoin. If false delete will fail if secure is enabled and current kdc_type is MS Windows. If secure is enabled either unjoin NFS server before doing delete or set value to true. -async Perform asynchronous operation. set Modify NFS server settings.
-is_nfsv4_enabled Indicates whether NFSv4 is enabled on the NAS server. When enabled, NFS shares can be accessed with NFSv4. When disabled, NFS shares cannot be accessed with NFSv4 protocol. true - NFSv4 is enabled on the specified NAS server. - false - NFSv4 is disabled on the specified NAS server. -is_secure_enabled Indicates whether secure NFS is enabled on the NFS server. - true - Secure NFS is Enabled. false - Secure NFS is disabled. -is_skip_unjoin Allow to bypass NFS server unjoin.
-domain_passwordSecure} [-async] Action qualifiers -id Unique identifier of the NFS server. -domain_user_name Name of a domain-user with privileges to join the Active Directory domain. -domain_password Password of the domain-user specified to join the Active Directory domain. -domain_passwordSecure Secure version of -domain_password. Value will be queried interactively. -async Perform asynchronous operation. unjoin Unjoin the secure NFS server from the NAS server’s Active Directory domain.
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. This resource type has queriable association from policy Attributes id Type: string Unique identifier representing a performance rule. name Type: string Name of the performance rule. This property supports case-insensitive filtering.
Attribute Select policies.is_replica X policies.name X policies.type X policies.type_l10n X Sort Search 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. -name Unique name of the existing object (performance_rule). -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. 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. Most usage of SMB involves computers running Microsoft Windows, but it is commonly supported on other types of systems as well.
point (!) - at sign (@) - number sign (#) - 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 Type: string Domain name where SMB server is registered in Active Directory, if applicable.
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.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 X X netbios_name X X X workgroup X X X Format smb_server [-id ] show [-select ,..] [-sort [+|-],..
-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.
-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. SMB servers joined to Active Directory also have NetBIOS Name, defaulted to the 15 first characters of the computer_name attribute. Administrators can specify a custom NetBIOS Name for a SMB server using this attribute. NetBIOS name is limited to 15 characters and cannot contain the following characters - - backslash (\) - slash mark (/) - colon
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.
Action qualifiers -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.
Local path to the file system or any existing sub-folder of the file system that is shared over the network. This path is relative to the NAS Server and must start with the filesystem’s mountpoint path, which is the filesystem name. For example to share the top-level of a 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.
Documents All files that users open will be available offline. Programs Program will preferably run from the offline cache even when connected to the network. All files that users open will be available offline. None Prevents clients from storing documents and programs in offline cache (default). umask Type: string The default UNIX umask for new files created on the Share. If not specified the umask defaults to 022.
Attribute Select 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.is_smb_no_notify_enabled X file_system.
Attribute Select Sort Search 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.
Action qualifiers -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. fieldsort 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.
create Create an SMB share.
Documents All files that users open will be available offline. Programs Program will preferably run from the offline cache even when connected to the network. All files that users open will be available offline. None Prevents clients from storing documents and programs in offline cache (default). -umask The default UNIX umask for new files created on the Share. If not specified the umask defaults to 022.
set Modify SMB share properties. Format smb_share {-id | -name } set [-description ] [-is_ABE_enabled {yes | true | no | false}] [-is_branch_cache_enabled {yes | true | no | 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 -id SMB share object id. -name Unique name of the existing object (smb_share).
-umask The default UNIX umask for new files created on the Share. -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.0 is enabled at the shared folder level.
more details show Property capabilities Attribute Select Sort Search id X X X name X X X quota 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.source_timestamp X virtual_volumes.storage_container_id X 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 Sort Search Format storage_container [{-id | -name }] show [-select ,..] [-sort [+|-],..
-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 virtual volume (vVol) storage container. Format storage_container create -name [-quota <0 .. 4611686018427387904 (4096.
Format storage_container {-id | -name } delete [-force {yes | true | no | false}] [async] Action qualifiers -id Storage container ID. -name Unique name of the existing object (storage_container). -force Normally, deletion of a storage container that is mounted or still contains virtual volumes will be rejected. This option overrides that error and allows the delete to continue. Use with great caution. -async Perform asynchronous operation. set Modify a storage container.
mount Mount a storage container as a vVol datastore in vCenter. Format storage_container {-id | -name } mount [-datastore_name ] [-async] Action qualifiers -id Storage container ID. -name Unique name of the existing object (storage_container). -datastore_name This will be the vVol datastore name in vCenter when it is mounted. -async Perform asynchronous operation. unmount Unmount a storage container, which removes the vVol datastore from vCenter.
id Type: string The unique identifier of the virtual volume. name Type: string The name of the virtual volume, based on metadata provided by vSphere. This property supports case-insensitive filtering. size Type: size (0 to 9223372036854775807 (8192.00P)) The size of the virtual volume in bytes. type Type: enumerated value ("Clone", "Fast_Clone", "Prepared_Snapshot", "Primary", "Snapshot") The logical type of a virtual volume.
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. is_readonly Type: boolean Indicates whether the virtual volume is read-only. migration_session_id Type: string If the virtual volume is part of a migration activity, the session ID for that migration. virtual_machine_uuid Type: string UUID of the virtual machine that owns this virtual volume.
Type: array of objects Filtering on the fields of this embedded resource is not supported. See location_history for more details type_l10n Type: string Localized message string corresponding to type. usage_type_l10n Type: string Localized message string corresponding to usage_type. io_priority_l10n Type: string Localized message string corresponding to io_priority. creator_type_l10n Type: string Localized message string corresponding to creator_type.
target_virtual_volumes This is the inverse of the resource type virtual_volume association. See virtual_volume for more details host_virtual_volume_mappings This is the inverse of the resource type host_virtual_volume_mapping association. See host_virtual_volume_mapping for more details 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.
Attribute Select appliance.service_tag X appliance_id X child_virtual_volumes.appliance_id X child_virtual_volumes.creation_timestamp X child_virtual_volumes.creator_type X 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.
Attribute Select Sort Search child_virtual_volumes.type_l10n X child_virtual_volumes.usage_type X child_virtual_volumes.usage_type_l10n X child_virtual_volumes.virtual_machine_uuid X creation_timestamp X X X 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.
Attribute Select Sort Search 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.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.
Attribute Select Sort Search parent.location_history X parent.migration_session_id X parent.name X parent.parent_id X parent.profile_id X 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.
Attribute Select source.family_id X source.id X source.io_priority X source.io_priority_l10n X source.is_readonly X 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.
Attribute Select storage_container.id X storage_container.name X storage_container.quota X storage_container_id X target_virtual_volumes.appliance_id X 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.
Attribute Select Sort Search target_virtual_volumes.storage_container_id X target_virtual_volumes.type X target_virtual_volumes.type_l10n X target_virtual_volumes.usage_type X target_virtual_volumes.usage_type_l10n X 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 Format virtual_volume [{-id | -name }] show [-select ,..] [-sort [+|-],..
fieldsort 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. delete Delete a virtual volume.
overrides that error and allows the delete to continue. -async Perform asynchronous operation. volume Manage volumes, including snapshots and clones of volumes. Details about a volume, including snapshots and clones of volumes. This resource type has queriable associations from appliance, policy, migration_session, host_volume_mapping, volume_group Attributes id Type: string Unique identifier of the volume instance. name Type: string Name of the volume.
appliance_id Type: string Unique identifier of the appliance on which the volume is provisioned. state Type: enumerated value ("Destroying", "Initializing", "Offline", "Ready") Volume life cycle states. Ready Volume is operating normally. 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.
Unique identifier of the performance policy assigned to the volume. is_replication_destination Type: boolean Indicates whether this volume 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.
appliance This is the embeddable reference form of appliance_id attribute. See appliance for more details protection_policy This is the embeddable reference form of protection_policy_id attribute. See policy for more details migration_session This is the embeddable reference form of migration_session_id attribute. See migration_session for more details mapped_volumes This is the inverse of the resource type host_volume_mapping association.
resource. If the deleted parent is of type Primary, the parent_id of the child resources will be set to null. parent_id Unique identifier of the resource from which a snapshot or clone resource is created. The parent_id is set when a resource is created and will only change if its parent resource is deleted. When a resource is deleted, its children get reparented to the parent of the deleted resource. If the deleted parent is of type Primary, the parent_id of the child resources will be set to null.
show Property capabilities Attribute Select Sort Search appliance.express_service_code X appliance.id X appliance.model X appliance.name X appliance.service_tag X 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.
Attribute Select Sort Search 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.source_appliance_id X migration_session.state X migration_session.
Attribute Select Sort Search protection_policy.type_l10n X protection_policy_id X X X size X X X state X X X 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.
Attribute Select volume_groups.type_l10n X wwn X Sort Search X X Format 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 volume to query. -name Unique name of the existing object (volume). -select Display selected attributes in the output.
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 volume on the appliance. 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..
-appliance_id Identifier of the appliance on which the volume is provisioned. -volume_group_id Volume group to add the volume to. If not specified, the volume is not added to a volume group. -min_size Optional minimum size for the volume, in bytes. -sector_size Optional sector size, in bytes. Only 512-byte and 4096-byte sectors are supported. -protection_policy_id Unique identifier of the protection policy assigned to the volume.
set Modify the parameters of a volume. Format volume {-id | -name } set [-name ] [-description ] [-size <8192 (8.00K) .. 281474976710656 (256.
-force Normally a replication destination volume 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 needs to be cleaned up. With the force option, the user will be allowed to remove the protection policy from the replication destination volume provided that the replication session has never been synchronized and the last_sync_timestamp property is empty.
Format volume {-id | -name } clone [-name ] [-description ] [-host_id ] [-host_group_id ] [-logical_unit_number <0..16383>] [-performance_policy_id ] [-protection_policy_id ] [-async] Action qualifiers -id Unique identifier of the volume or snapshot to create a clone of. -name Unique name of the existing object (volume). -name Name of the clone. This value must contain 128 or fewer printable Unicode characters. -description Description of the clone.
Action qualifiers -id Unique identifier of volume to detach. -name Unique name of the existing object (volume). -host_id Unique identifier of the host to be detached from this volume. Only one of host_id or host_group_id can be supplied. -host_group_id Unique identifier of the host group to be detached from this volume. Only one of host_id or host_group_id can be supplied. -async Perform asynchronous operation. refresh Refresh the contents of the target volume from another volume in the same family.
-create_backup_snap Indicates whether to create a backup snapshot of the volume before refreshing. -backup_snap_profile Profile for the backup snapshot. -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.
-id Unique identifier of the volume to restore. -name Unique name of the existing object (volume). -from_snap_id Unique identifier of the source snapshot for the restore operation. -create_backup_snap Indicates whether to create a backup snapshot of the volume before restoring. -backup_snap_profile Profile for the backup snapshot. -name Name of the snapshot to be created. This value must contain 128 or fewer printable Unicode characters.
-id Unique identifier of the volume or clone to create a snapshot of. -name Unique name of the existing object (volume). -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. -expiration_timestamp Expiration time of the snapshot.
description Type: string Description for the volume group. creation_timestamp Type: date time The time at which the volume group was created. is_protectable Type: boolean 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.
Filtering on the fields of this embedded resource is not supported. 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. is_replication_destination Type: boolean Indicates whether this volume group is a replication destination.
type_l10n Type: string Localized message string corresponding to type. protection_policy This is the embeddable reference form of protection_policy_id attribute. See policy for more details 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.
parent_id is set when a resource is created and will only change if its parent resource is deleted. When a resource is deleted, its children get reparented to the parent of the deleted resource. If the deleted parent is of type Primary, the parent_id of the child resources will be set to null. copy_signature Used for tracking replicated copies of a snapshot set. is_app_consistent A boolean flag that indicates whether the snapshot is application consistent.
Attribute Select Sort Search description X X X id X X X is_importing X X X is_protectable X X X is_replication_destination X X X is_write_order_consistent X X X 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.
Attribute Select Sort Search migration_session_id X X X name X X X placement_rule 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.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.
Attribute Select volumes.node_affinity X volumes.node_affinity_l10n 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.wwn X Sort Search Format volume_group [{-id | -name }] show [-select ,..] [-sort [+|],..
fieldsort 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 volume group. The resulting volume group will have a type of Primary.
Description for the volume group. The description should not be more than 256 characters long and should not have any unprintable characters. If description is not specified, the description for the volume group will not be set. -volume_ids A list of identifiers of existing volumes that should be added to the volume group. All the volumes must be on the same Cyclone appliance and should not be part of another volume group.
parameter to true to override this behavior and also delete the members after they are removed from the volume group. This parameter defaults to false, if not specified. -async Perform asynchronous operation. set Modify a volume group, snapshot set, or clone.
succeeds in modifying the is_replication_destination property of a subset of volumes, is_replication_destination property for the volume group will be set to true. Modification of this property is idempotent. This parameter is only valid when modifying a primary or a clone volume group, only when the volume group is no longer the destination of a replication session, and may only be set to false. -force Normally a replication destination volume group cannot be modified since it is controlled by replication.
clone Clone a volume group. The clone volume group will be created on the same appliance as the source volume group. A clone of a volume group will result in a new volume group of Clone type. The clone will belong to the same family as the source volume group. When the source of a clone operation is a either primary or clone volume group, • source_id will be set to the identifier of the source volume group. • source_time will be set to the time at which the clone will be created.
refresh Refresh the contents of a volume group (the target volume group) from another volume group in the same family. A backup snapshot set of the target volume group will be created before refresh is attempted. This behavior can be overridden by setting the create_backup_snap property to false. The profile for the backup snapshot set will be auto-generated, unless a custom profile is specified. The auto-generated profile only initializes the name to an auto-generated, unique value.
-description Optional description for the snapshot set. If description is not specified, the description for the snapshot set will not be set. -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 -volume_names ,..
A volume group that is acting as the destination in a replication session cannot be restored. Format volume_group {-id | -name } restore -from_snap_id [-create_backup_snap {yes | true | no | false}] [-backup_snap_profile -name [-description ]] [-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.
snapshot set will be write-order consistent. Format volume_group {-id | -name } snapshot -name [-description ] [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. -description Optional description for the snapshot set. If description is not specified, the description for the snapshot set will not be set. -async Perform asynchronous operation.
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 Sort Search appliance.express_service_code X appliance.id X appliance.model X appliance.name X appliance.
Action qualifiers -id Unique identifier of the maintenance window configuration. -select Display selected attributes in the output. -sort Sorts output field+ (or just field) sort by field in ascending order. fieldsort 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.
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. This value is required if is_enabled is passed as true, and may not be more than 172800 (48 hours). -async Perform asynchronous operation.
show Property capabilities 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.
-id Unique identifier of the instance. -is_ssh_enabled Current SSH service access state. 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.
Attribute Select id X is_built_in X is_default_password X name X Sort Search 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.
-id Unique identifier of the service user account. -password New password for the service user account. The password value can be 8 to 40 UTF-8 characters long, and include as a minimum one uppercase character, one lowercase character, one numeric character, and one special character from this list [!,@#$%^*>_~]. -passwordSecure Secure version of -password. Value will be queried interactively. -async Perform asynchronous operation.
Type: string Model of the appliance. 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.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.port_connector_type X eth_ports.
Attribute Select eth_ports.sfp_id 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.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.port_connector_type_l10n X fc_ports.port_index X fc_ports.requested_speed X fc_ports.
Attribute Select fc_ports.wwn 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.part_number X hardware.serial_number X hardware.slot 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.
Attribute Select Sort Search 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.appliance_id X maintenance_windows.end_time X maintenance_windows.id X maintenance_windows.is_enabled X model X X X name X X X nodes.appliance_id X nodes.id X nodes.slot X sas_ports.appliance_id X sas_ports.id X sas_ports.io_module_id X sas_ports.is_link_up X sas_ports.name X sas_ports.
Attribute Select sas_ports.sfp_id X sas_ports.speed X sas_ports.speed_l10n X service_tag X software_installed.id X software_installed.installed_date X software_installed.is_cluster X software_installed.release_id 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.name 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.node_affinity X volumes.node_affinity_l10n X volumes.performance_policy_id X volumes.protection_data X volumes.protection_policy_id X volumes.
Attribute Select 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.
csv Display output in CSV format. table Display output in a table. json Display output in JSON format. set Modify an appliance’s name. Format appliance {-id | -name } set -name [-async] Action qualifiers -id Unique identifier of the appliance. -name Unique name of the existing object (appliance). -name New name of the appliance. -async Perform asynchronous operation. forecast Forecast capacity usage for an 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. Format appliance {-id | -name } time_to_full -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.
is_link_up Type: boolean Indicates whether the bond’s link is up. Values are: true Link is up. false Link is down. mtu Type: 32-bit signed integer (0 to 2147483647) Maximum Transmission Unit (MTU) packet size that the bond can transmit, in bytes. mode Type: enumerated value ("LACP") Bond mode. LACP Uses an IEEE 802.3ad dynamic link aggregation policy. Aggregation groups share the same speed and duplex settings. This mode transmits and receives network traffic on all slaves in the active aggregator.
Attribute Select eth_ports.current_speed X eth_ports.current_speed_l10n 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.port_connector_type X eth_ports.port_connector_type_l10n X eth_ports.
Attribute Select Sort Search 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.veth_port_id X is_link_up X X X mode X X X mode_l10n X X X mtu X X X name X X X Format bond [{-id | -name }] show [-select ,..
-name Unique name of the existing object (bond). -select Display selected attributes in the output. -sort Sorts output field+ (or just field) sort by field in ascending order. fieldsort 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 The id of the cluster. global_id The global id of the cluster. name The name of the cluster. management_address The management IP address. storage_discovery_address The floating storage discovery address for the cluster. master_appliance_id The id of the appliance acting as master. appliance_count Number of appliances configured in this cluster. physical_mtu The physical ethernet port (eth_port resource) MTU setting, global for all ports in the cluster.
show Property capabilities Attribute Select appliance_count X compatibility_level X global_id X id X is_encryption_enabled X management_address X master_appliance_id X name X physical_mtu X state X state_l10n X storage_discovery_address X Sort Search Format cluster [-id ] show [-select ,..] [-output {nvp | csv [-table] [-noformat] | table | json [-raw]}] Action qualifiers -id ID of the cluster. -select Display selected attributes in the output.
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 cluster properties, such as physical MTU. Format cluster -id set [-name ] [-physical_mtu <1500..9000>] [-async] Action qualifiers -id Unique identifier of the cluster. -name The name of the cluster. The name can be up to 64 UTF-8 characters and cannot be an empty string.
-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 -id time_to_full -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. eth_port This is the REST API for cluster-wide retrieval and configuration of Ethernet front-end ports.
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 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. For the requested_speed attribute, these values show the transmission speed set by the user.
fabric MTU can be set to any value in the range [1500-9000]. The network MTU can be set to any value in the range [1280-9000]. The network MTU must be less than or equal to the current fabric MTU. sfp_id Type: string Unique identifier of the hardware instance of type 'SFP' (Small Form-factor Pluggable) inserted into the port. io_module_id Type: string Unique identifier of the hardware instance of type 'IO_Module' handling the port.
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 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.
insensitive filtering. hypervisor_port_id Type: 32-bit signed integer (0 to 2147483647) Unique identifier of the virtual switch port associated with the hypervisor port. hypervisor_vswitch_id Type: string Unique identifier of the virtual switch associated with the hypervisor port. 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.
details partner This is the embeddable reference form of partner_id attribute. See eth_port for more details show Property capabilities Attribute Select Sort Search appliance.express_service_code X appliance.id X appliance.model X appliance.name X appliance.service_tag X appliance_id X X X bond.id X bond.is_link_up X bond.mode X bond.mode_l10n X bond.mtu X bond.
Attribute Select Sort Search 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.slot X io_module.status_led_state X io_module.status_led_state_l10n X io_module.
Attribute Select Sort Search 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.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.
Attribute Select node.part_number X node.serial_number X node.slot 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.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.
Attribute Select Sort Search 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.sfp_id X partner.supported_speeds X partner.
Attribute Select Sort Search 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.status_led_state X sfp.status_led_state_l10n X sfp.type X sfp.type_l10n X sfp_id X X X supported_speeds X X X supported_speeds_l10n X X X Format eth_port [{-id | -name }] show [-select ,..] [-sort [+|-],..
-select Display selected attributes in the output. -sort Sorts output field+ (or just field) sort by field in ascending order. fieldsort 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.
Format eth_port {-id | -name } set -requested_speed {Auto | 10_Mbps | 100_Mbps | 1_Gbps | 10_Gbps | 25_Gbps | 40_Gbps} [-async] Action qualifiers -id Unique identifier of the port. -name Unique name of the existing object (eth_port). -requested_speed Supported Ethernet front-end port transmission speeds. For the current_speed attribute, these values show the current transmission speed on the port. For the requested_speed attribute, these values show the transmission speed set by the user.
This resource type has queriable associations from appliance, hardware, fc_port Attributes id Type: string Unique identifier of the port. name Type: string Name of the port. This property supports case-insensitive filtering. appliance_id Type: string Unique identifier of the appliance containing the port. node_id Type: string Unique identifier of the hardware instance of type 'Node' containing the port. wwn Type: string World Wide Name (WWN) of the port.
the transmission speed set by the user. A requested speed of Auto means that the current speed value will be automatically detected. If this file is updated, also update 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. requested_speed Type: enumerated value ("16_Gbps", "32_Gbps", "4_Gbps", "8_Gbps", "Auto") Possible Fibre Channel port speeds.
io_module_id Type: string Unique identifier of the hardware instance of type 'IO_Module' handling the port. port_index Type: 32-bit signed integer (0 to 2147483647) Index of the port in the IO module. port_connector_type Type: enumerated value ("BNC_TNC", "Copper_Pigtail", "FC_Coaxial_Headers", "FC_Style1_Copper", "FC_Style2_Copper", "FiberJack", "HSSDC_II", "LC", "MT_RJ", "MU", "MXC_2x16", "No_Separable", "Optical_Pigtail", "RJ45", "SC", "SG", "Unknown") Type of connector supported by the port.
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. 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.
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 partner This is the embeddable reference form of partner_id attribute. See fc_port for more details show Property capabilities Attribute Select Sort Search appliance.express_service_code X appliance.id X appliance.model X appliance.name X appliance.
Attribute Select Sort Search 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.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.
Attribute Select node.serial_number X node.slot 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.current_speed X partner.current_speed_l10n 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.requested_speed X partner.
Attribute Select Sort Search partner.sfp_id X partner.supported_speeds X partner.supported_speeds_l10n X partner.wwn 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.
Attribute Select Sort Search sfp.status_led_state X sfp.status_led_state_l10n X sfp.type X sfp.type_l10n X sfp_id X X X supported_speeds X X X supported_speeds_l10n X X X wwn X X X Format fc_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 FC front-end port.
-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 FC front-end port’s speed. Setting the port’s requested speed might not cause the port speed to change immediately.
current transmission speed on the port. For the requested_speed attribute, these values show the transmission speed set by the user. A requested speed of Auto means that the current speed value will be automatically detected. If this file is updated, also update 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 -async Perform asynchronous operation.
lifecycle_state Type: enumerated value ("Disconnected", "Empty", "Failed", "Healthy", "Initializing", "Prepare_Failed", "Trigger_Update", "Uninitialized") Life cycle state of the component. parent_id Type: string The id of the component’s parent, or null if this component is at the top of the parent hierarchy. appliance_id Type: string The id of the component’s associated appliance. slot Type: 32-bit signed integer (0 to 2147483647) The slot or location of the component.
Type: string Localized message string corresponding to type. lifecycle_state_l10n Type: string Localized message string corresponding to lifecycle_state. status_led_state_l10n Type: string Localized message string corresponding to status_led_state. node_fc_ports This is the inverse of the resource type fc_port association. See fc_port for more details sfp_fc_ports This is the inverse of the resource type fc_port association.
details Attributes of extra_details cpu_model CPU model name. Available on Node hardware type. physical_memory_size_gb Total amount of physical memory in gigabytes. Available on the Node hardware type. cpu_cores Total number of physical cores. Available on the Node hardware type. cpu_sockets Total number of physical sockets. Available on the Node hardware type. bus_number Bus number of the Expansion_Shelf. Available on the Expansion_Shelf hardware type.
FC This SFP supports Fibre Channel. Ethernet This SFP supports Ethernet. FC_Ethernet This SFP supports Fibre Channel or Ethernet. SAS This SFP supports SAS for connections to Expansion Enclosures. connector_type Connector type. Available on the SFP hardware type.
Optical_Pigtail Optical Pigtail Connector HSSDC_II High Speed Serial Data Connector Copper_Pigtail Copper Pigtail Connector RJ45 RJ45 Connector No_Separable Non-seperable Connector MXC_2x16 MXC 2x16 Connector drive_type Type of drive. Available on the Drive hardware type. Current types are: ◦ Unknown SAS_SSD SAS-connected SSD in an Expansion Enclosure. NVMe_SCM NVME-Connected Storage Class Memory. NVMe_NVRAM NVME-Connected Non-volatile RAM. NVMe_SSD NVME-Connected SSD. size Size of the drive in bytes.
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_Locked_Foreign Drive supports encryption and is locked with an unknown PIN. Supported_Processing Drive supports encryption and is being processed. Disabled Drive encryption is disabled. fips_status FIPS compliance level. Available on the Drive hardware type.
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.express_service_code X appliance.id X appliance.model X appliance.name X appliance.
Attribute Select Sort Search children.parent_id X children.part_number X children.serial_number X children.slot X children.status_led_state X children.status_led_state_l10n X children.type X children.type_l10n X extra_details X X X id X X X io_module_eth_ports.appliance_id X io_module_eth_ports.bond_id X io_module_eth_ports.current_mtu X io_module_eth_ports.current_speed X io_module_eth_ports.current_speed_l10n X io_module_eth_ports.
Attribute Select 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.name X io_module_eth_ports.node_id X io_module_eth_ports.partner_id X io_module_eth_ports.port_connector_type X io_module_eth_ports.port_connector_type_l10n X io_module_eth_ports.port_index X io_module_eth_ports.requested_speed X io_module_eth_ports.requested_speed_l10n X io_module_eth_ports.sfp_id X io_module_eth_ports.
Attribute Select io_module_fc_ports.node_id X io_module_fc_ports.partner_id X io_module_fc_ports.port_connector_type X io_module_fc_ports.port_connector_type_l10n X io_module_fc_ports.port_index X io_module_fc_ports.requested_speed X io_module_fc_ports.requested_speed_l10n X io_module_fc_ports.sfp_id X io_module_fc_ports.supported_speeds X io_module_fc_ports.supported_speeds_l10n X io_module_fc_ports.wwn X io_module_sas_ports.appliance_id X io_module_sas_ports.
Attribute Select Sort Search io_module_sas_ports.speed_l10n X is_marked X X X 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.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.
Attribute Select node_eth_ports.partner_id X 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.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.id X node_fc_ports.io_module_id X node_fc_ports.
Attribute Select node_fc_ports.requested_speed X node_fc_ports.requested_speed_l10n X node_fc_ports.sfp_id X node_fc_ports.supported_speeds X node_fc_ports.supported_speeds_l10n X node_fc_ports.wwn X node_sas_ports.appliance_id X node_sas_ports.id X node_sas_ports.io_module_id X node_sas_ports.is_link_up X node_sas_ports.name X node_sas_ports.node_id X node_sas_ports.partner_id X node_sas_ports.port_index X node_sas_ports.sfp_id X node_sas_ports.speed X node_sas_ports.
Attribute Select Sort Search 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.status_led_state X parent.status_led_state_l10n X 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.
Attribute Select sfp_eth_ports.hypervisor_vswitch_id X sfp_eth_ports.hypervisor_vswitch_name X sfp_eth_ports.id X sfp_eth_ports.io_module_id X sfp_eth_ports.is_hypervisor_managed X sfp_eth_ports.is_link_up X sfp_eth_ports.mac_address X sfp_eth_ports.name X 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.
Attribute Select sfp_fc_ports.id X sfp_fc_ports.io_module_id X sfp_fc_ports.is_link_up X sfp_fc_ports.name X sfp_fc_ports.node_id X 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.requested_speed X sfp_fc_ports.requested_speed_l10n X sfp_fc_ports.sfp_id X sfp_fc_ports.supported_speeds X sfp_fc_ports.supported_speeds_l10n X sfp_fc_ports.wwn X sfp_sas_ports.
Attribute Select Sort Search 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 slot X X X status_led_state X X X status_led_state_l10n X X X type X X X type_l10n X X X Format hardware [{-id | -name }] show [-select ,..] [-sort [+|-],..
-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 a hardware instance.
the Base_Enclosure and Expansion_Enclosure apply to their children (Nodes and Drives for Base_Enclosure and Drives for Expansion_Enclosure). For components with a single physical LED (Base_Enclosure and Node), setting is_marked=true overrides the status_led_state property from on (or off) to Null, and setting is_marked=false reverts status_led_state to showing the state of the physical LED. -async Perform asynchronous operation.
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. See ip_pool_address for more details veth_ports This is the inverse of the resource type veth_port association.
Attribute Select ip_pool_addresses.ip_port_id 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 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.name X veth_ports.node_id X veth_ports.vswitch_name X veth_ports.vswitch_port_group_name X veth_ports.vswitch_port_id X veth_ports.
-id Unique identifier of the node. -select Display selected attributes in the output. -sort Sorts output field+ (or just field) sort by field in ascending order. fieldsort 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.
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. node_id Type: string Unique identifier of the hardware instance of type 'Node' containing the port. is_link_up Type: boolean Indicates whether the SAS port’s link is up. Values are: true Link is up. false Link is down.
Type: string Unique identifier of the hardware instance of type 'IO_Module' handling the port. port_index Type: 32-bit signed integer (0 to 2147483647) Index of the SAS port in IO module. partner_id Type: string Unique identifier of the SAS partner port. speed_l10n Type: string Localized message string corresponding to speed. 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.
Attribute Select Sort Search appliance.service_tag X appliance_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.parent_id X io_module.part_number X io_module.serial_number X io_module.slot X io_module.status_led_state X io_module.status_led_state_l10n X io_module.type X io_module.
Attribute Select 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.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.id X partner.io_module_id X partner.is_link_up X partner.
Attribute Select Sort Search partner.node_id X partner.partner_id X partner.port_index X partner.sfp_id X partner.speed X partner.speed_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.status_led_state X sfp.
Attribute Select Sort Search sfp.type X sfp.type_l10n X sfp_id X X X speed X X X speed_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. -name Unique name of the existing object (sas_port). -select Display selected attributes in the output.
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.
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: 32-bit signed integer (0 to 2147483647) Maximum Transmission Unit (MTU) packet size that the virtual Ethernet port can transmit.
node This is the embeddable reference form of node_id attribute. See node for more details show Property capabilities Attribute Select Sort Search appliance.express_service_code X appliance.id X appliance.model X appliance.name X appliance.service_tag X appliance_id X X X current_mtu X X X current_speed X X 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.
Attribute Select Sort Search 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 vswitch_name X X X vswitch_port_group_name X X X vswitch_port_id X X X vswitch_port_name X X X Format veth_port [{-id | -name }] show [-select ,..] [-sort [+|],..
field+ (or just field) sort by field in ascending order. fieldsort 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.
