dellemc.powerflex.info_v2 module – Gathering information about Dell PowerFlex

Note

This module is part of the dellemc.powerflex collection (version 3.0.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install dellemc.powerflex. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: dellemc.powerflex.info_v2.

New in dellemc.powerflex 3.0.0

Synopsis

  • Gathering information about Dell PowerFlex storage system includes getting the api details, list of devices, NVMe host, protection domains, SDCs, SDT, snapshot policies, storage pools, volumes.

  • Gathering information about Dell PowerFlex Manager includes getting the list of deployments, firmware repository, managed devices, service templates.

  • Support only for Powerflex 5.0 versions and above.

Requirements

The below requirements are needed on the host that executes this module.

  • A Dell PowerFlex storage system version 5.0 or later.

  • PyPowerFlex 2.0.0

Parameters

Parameter

Comments

filters

list / elements=dictionary

List of filters to support filtered output for storage entities.

Each filter is a dictionary with keys filter_key, filter_operator, filter_value.

Supports passing of multiple filters.

filter_key

string / required

Name identifier of the filter.

filter_operator

string / required

Operation to be performed on filter key.

Choice contains is supported for gather_subset keys service_template, managed_device, deployment, firmware_repository.

Choices:

  • "equal"

  • "contains"

filter_value

string / required

Value of the filter key.

full

boolean

Specify if response is full or brief.

Applicable when gather_subset is deployment, service_template.

For deployment specify to use full templates including resources in response.

Choices:

  • false ← (default)

  • true

gather_subset

list / elements=string

List of string variables to specify the PowerFlex storage system entities for which information is required.

Devices - device.

Deployments - deployment.

FirmwareRepository - firmware_repository.

Managed devices - managed_device.

NVMe host - nvme_host

NVMe Storage Data Target - sdt.

Protection domains - protection_domain.

SDCs - sdc.

Service templates - service_template.

Snapshot policies - snapshot_policy.

Storage pools - storage_pool.

Volumes - vol.

Choices:

  • "deployment"

  • "device"

  • "firmware_repository"

  • "managed_device"

  • "nvme_host"

  • "protection_domain"

  • "sdc"

  • "sdt"

  • "service_template"

  • "snapshot_policy"

  • "storage_pool"

  • "vol"

hostname

aliases: gateway_host

string / required

IP or FQDN of the PowerFlex host.

include_attachments

boolean

Include attachments.

Applicable when gather_subset is service_template.

Choices:

  • false

  • true ← (default)

include_bundles

boolean

Include software bundle entities.

Applicable when gather_subset is firmware_repository.

Choices:

  • false ← (default)

  • true

include_devices

boolean

Include devices in response.

Applicable when gather_subset is deployment.

Choices:

  • false

  • true ← (default)

include_template

boolean

Include service templates in response.

Applicable when gather_subset is deployment.

Choices:

  • false

  • true ← (default)

limit

integer

Page limit.

Supported for gather_subset keys service_template, managed_device, deployment, firmware_repository.

Default: 50

offset

integer

Pagination offset.

Supported for gather_subset keys service_template, managed_device, deployment, firmware_repository.

Default: 0

password

string / required

The password of the PowerFlex host.

port

integer

Port number through which communication happens with PowerFlex host.

Default: 443

sort

string

Sort the returned components based on specified field.

Supported for gather_subset keys service_template, managed_device, deployment, firmware_repository.

The supported sort keys for the gather_subset can be referred from PowerFlex Manager API documentation in https://developer.dell.com.

timeout

integer

Time after which connection will get terminated.

It is to be mentioned in seconds.

Default: 120

username

string / required

The username of the PowerFlex host.

validate_certs

aliases: verifycert

boolean

Boolean variable to specify whether or not to validate SSL certificate.

true - Indicates that the SSL certificate should be verified.

false - Indicates that the SSL certificate should not be verified.

Choices:

  • false

  • true ← (default)

Notes

Note

  • The supported filter keys for the gather_subset can be referred from PowerFlex Manager API documentation in https://developer.dell.com.

  • The filter, sort, limit and offset options will be ignored when more than one gather_subset is specified along with deployment, firmware_repository, managed_device or service_template.

  • The modules present in the collection named as ‘dellemc.powerflex’ are built to support the Dell PowerFlex storage platform.

Examples

- name: Get detailed list of PowerFlex entities
  dellemc.powerflex.info_v2:
    hostname: "{{ hostname }}"
    username: "{{ username }}"
    password: "{{ password }}"
    validate_certs: "{{ validate_certs }}"
    gather_subset:
      - vol
      - storage_pool
      - protection_domain
      - sdc
      - snapshot_policy
      - device
      - nvme_host
      - sdt

- name: Get specific volume details
  dellemc.powerflex.info_v2:
    hostname: "{{ hostname }}"
    username: "{{ username }}"
    password: "{{ password }}"
    validate_certs: "{{ validate_certs }}"
    gather_subset:
      - vol
    filters:
      - filter_key: "name"
        filter_operator: "equal"
        filter_value: "ansible_test"

- name: Get specific NVMe hosts details
  dellemc.powerflex.info_v2:
    hostname: "{{ hostname }}"
    username: "{{ username }}"
    password: "{{ password }}"
    validate_certs: "{{ validate_certs }}"
    gather_subset:
      - nvme_host
    filters:
      - filter_key: "name"
        filter_operator: "equal"
        filter_value: "ansible_test"

- name: Get deployment and resource provisioning info
  dellemc.powerflex.info_v2:
    hostname: "{{ hostname }}"
    username: "{{ username }}"
    password: "{{ password }}"
    validate_certs: "{{ validate_certs }}"
    gather_subset:
      - managed_device
      - deployment
      - service_template

- name: Get deployment with filter, sort, pagination
  dellemc.powerflex.info_v2:
    hostname: "{{ hostname }}"
    username: "{{ username }}"
    password: "{{ password }}"
    validate_certs: "{{ validate_certs }}"
    gather_subset:
      - deployment
    filters:
      - filter_key: "name"
        filter_operator: "contains"
        filter_value: "partial"
    sort: name
    limit: 10
    offset: 10
    include_devices: true
    include_template: true

- name: Get the list of firmware repository.
  dellemc.powerflex.info_v2:
    hostname: "{{ hostname }}"
    username: "{{ username }}"
    password: "{{ password }}"
    validate_certs: "{{ validate_certs }}"
    gather_subset:
      - firmware_repository

- name: Get the list of firmware repository
  dellemc.powerflex.info_v2:
    hostname: "{{ hostname }}"
    username: "{{ username }}"
    password: "{{ password }}"
    validate_certs: "{{ validate_certs }}"
    gather_subset:
      - firmware_repository
    include_bundles: true

- name: Get the list of firmware repository with filter
  dellemc.powerflex.info_v2:
    hostname: "{{ hostname }}"
    username: "{{ username }}"
    password: "{{ password }}"
    validate_certs: "{{ validate_certs }}"
    gather_subset:
      - firmware_repository
    filters:
      - filter_key: "createdBy"
        filter_operator: "equal"
        filter_value: "admin"
    sort: createdDate
    limit: 10
    include_bundles: true
  register: result_repository_out

- name: Get the list of available firmware repository
  ansible.builtin.debug:
    msg: "{{ result_repository_out.FirmwareRepository | selectattr('state', 'equalto', 'available') }}"

- name: Get the list of software components in the firmware repository
  ansible.builtin.debug:
    msg: "{{ result_repository_out.FirmwareRepository |
        selectattr('id', 'equalto', '8aaa80788b7') | map(attribute='softwareComponents') | flatten }}"

- name: Get the list of software bundles in the firmware repository
  ansible.builtin.debug:
    msg: "{{ result_repository_out.FirmwareRepository |
        selectattr('id', 'equalto', '8aaa80788b7') | map(attribute='softwareBundles') | flatten }}"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

API_Version

string

API version of PowerFlex API Gateway.

Returned: always

Sample: "5.0"

Array_Details

dictionary

System entities of PowerFlex storage array.

Returned: always

Sample: {"addressSpaceUsage": "Normal", "authenticationMethod": "Mno", "capacityAlertCriticalThresholdPercent": 90, "capacityAlertHighThresholdPercent": 80, "capacityTimeLeftInDays": "78", "cliPasswordAllowed": true, "daysInstalled": 12, "defragmentationEnabled": true, "enterpriseFeaturesEnabled": true, "id": "815945c41cd8460f", "installId": "0076d6af044b5481", "isInitialLicense": true, "lastUpgradeTime": 0, "managementClientSecureCommunicationEnabled": true, "maxCapacityInGb": "Unlimited", "mdmCluster": {"clusterMode": "ThreeNodes", "clusterState": "ClusteredNormal", "goodNodesNum": 3, "goodReplicasNum": 2, "id": "-9126186461289757169", "master": {"id": "2d5f17673e35a101", "ips": ["10.225.106.68"], "managementIPs": ["10.225.106.68"], "opensslVersion": "OpenSSL 3.1.4 24 Oct 2023", "port": 9011, "role": "Manager", "status": "Normal", "versionInfo": "R5_0.0.0", "virtualInterfaces": ["ens160"]}, "slaves": [{"id": "5c613b076fb30100", "ips": ["10.225.106.67"], "managementIPs": ["10.225.106.67"], "opensslVersion": "OpenSSL 3.1.4 24 Oct 2023", "port": 9011, "role": "Manager", "status": "Normal", "versionInfo": "R5_0.0.0", "virtualInterfaces": ["ens160"]}], "standbyMDMs": [{"id": "1ef63c213b382503", "ips": ["10.225.106.48"], "managementIPs": ["10.225.106.48"], "opensslVersion": "N/A", "port": 9011, "role": "Manager", "virtualInterfaces": []}], "tieBreakers": [{"id": "6b5ae1c7248e0c02", "ips": ["10.225.106.69"], "managementIPs": ["10.225.106.69"], "opensslVersion": "N/A", "port": 9011, "role": "TieBreaker", "status": "Normal", "versionInfo": "R5_0.0.0"}]}, "mdmExternalPort": 7611, "mdmManagementPort": 8611, "mdmSecurityPolicy": "Authentication", "showGuid": true, "swid": "", "systemVersionName": "DellEMC PowerFlex Version: R5_0.0.937", "tlsVersion": "TLSv1.2", "upgradeState": "NoUpgrade"}

addressSpaceUsage

string

Address space usage.

Returned: success

authenticationMethod

string

Authentication method.

Returned: success

capacityAlertCriticalThresholdPercent

integer

Capacity alert critical threshold percentage.

Returned: success

capacityAlertHighThresholdPercent

integer

Capacity alert high threshold percentage.

Returned: success

capacityTimeLeftInDays

string

Capacity time left in days.

Returned: success

cliPasswordAllowed

boolean

CLI password allowed.

Returned: success

daysInstalled

integer

Days installed.

Returned: success

defragmentationEnabled

boolean

Defragmentation enabled.

Returned: success

enterpriseFeaturesEnabled

boolean

Enterprise features enabled.

Returned: success

id

string

The ID of the system.

Returned: success

installId

string

installation Id.

Returned: success

isInitialLicense

boolean

Initial license.

Returned: success

lastUpgradeTime

integer

Last upgrade time.

Returned: success

managementClientSecureCommunicationEnabled

boolean

Management client secure communication enabled.

Returned: success

maxCapacityInGb

string

Maximum capacity in GB.

Returned: success

mdmCluster

dictionary

MDM cluster details.

Returned: success

clusterMode

string

Cluster mode.

Returned: success

clusterState

string

Cluster state.

Returned: success

goodNodesNum

integer

Number of good nodes.

Returned: success

goodReplicasNum

integer

Number of good replicas.

Returned: success

id

string

Cluster ID.

Returned: success

master

dictionary

Master MDM node details.

Returned: success

id

string

Node ID.

Returned: success

ips

list / elements=string

List of IP addresses.

Returned: success

managementIPs

list / elements=string

List of management IP addresses.

Returned: success

opensslVersion

string

OpenSSL version.

Returned: success

port

integer

Communication port.

Returned: success

role

string

Node role.

Returned: success

status

string

Node status.

Returned: success

versionInfo

string

Version information.

Returned: success

virtualInterfaces

list / elements=string

List of virtual interfaces.

Returned: success

slaves

list / elements=dictionary

Slave MDM nodes.

Returned: success

id

string

Node ID.

Returned: success

ips

list / elements=string

List of IP addresses.

Returned: success

managementIPs

list / elements=string

List of management IP addresses.

Returned: success

opensslVersion

string

OpenSSL version.

Returned: success

port

integer

Communication port.

Returned: success

role

string

Node role.

Returned: success

status

string

Node status.

Returned: success

versionInfo

string

Version information.

Returned: success

virtualInterfaces

list / elements=string

List of virtual interfaces.

Returned: success

standbyMDMs

list / elements=dictionary

Standby MDM nodes.

Returned: success

id

string

Node ID.

Returned: success

ips

list / elements=string

List of IP addresses.

Returned: success

managementIPs

list / elements=string

List of management IP addresses.

Returned: success

opensslVersion

string

OpenSSL version.

Returned: success

port

integer

Communication port.

Returned: success

role

string

Node role.

Returned: success

virtualInterfaces

list / elements=string

List of virtual interfaces.

Returned: success

tieBreakers

list / elements=dictionary

Tie-breaker nodes.

Returned: success

id

string

Node ID.

Returned: success

ips

list / elements=string

List of IP addresses.

Returned: success

managementIPs

list / elements=string

List of management IP addresses.

Returned: success

opensslVersion

string

OpenSSL version.

Returned: success

port

integer

Communication port.

Returned: success

role

string

Node role.

Returned: success

status

string

Node status.

Returned: success

versionInfo

string

Version information.

Returned: success

mdmExternalPort

integer

MDM external port.

Returned: success

mdmManagementPort

integer

MDM management port.

Returned: success

mdmSecurityPolicy

string

MDM security policy.

Returned: success

showGuid

boolean

Show guid.

Returned: success

swid

string

SWID.

Returned: success

systemVersionName

string

System version and name.

Returned: success

tlsVersion

string

TLS version.

Returned: success

upgradeState

string

Upgrade state.

Returned: success

changed

boolean

Whether or not the resource has changed.

Returned: always

Sample: false

Deployments

list / elements=string

Details of all deployments.

Returned: when gather_subset is deployment

Sample: [{"allUsersAllowed": true, "assignedUsers": [], "brownfield": false, "compliant": false, "configurationChange": false, "createdBy": "admin", "createdDate": "2025-09-09T13:42:55.611+00:00", "currentBatchCount": null, "currentStepCount": null, "currentStepMessage": null, "customImage": "rcm_linux", "deploymentDescription": null, "deploymentDevice": [{"brownfield": false, "brownfieldStatus": "NOT_APPLICABLE", "cloudLink": false, "compliantState": "COMPLIANT", "componentId": null, "currentIpAddress": "10.226.197.13", "dasCache": false, "deviceGroupName": "Global", "deviceHealth": "GREEN", "deviceState": "DEPLOYING", "deviceType": "RackServer", "healthMessage": "OK", "ipAddress": "10.226.197.13", "logDump": null, "model": "PowerFlex custom node R650 S", "puppetCertName": "rackserver-bdwmcx3", "refId": "8aaa07b2992a323a01992bc3945606cc", "refType": null, "serviceTag": "BDWMCX3", "status": null, "statusEndTime": null, "statusMessage": null, "statusStartTime": null}], "deploymentFinishedDate": null, "deploymentHealthStatusType": "yellow", "deploymentName": "ECBlock", "deploymentScheduledDate": null, "deploymentStartedDate": "2025-09-09T14:21:11.073+00:00", "deploymentValid": null, "deploymentValidationResponse": null, "disruptiveFirmware": false, "firmwareInit": false, "firmwareRepository": {"bundleCount": 0, "componentCount": 0, "createdBy": null, "createdDate": null, "custom": false, "defaultCatalog": false, "deployments": [], "diskLocation": null, "downloadProgress": 0, "downloadStatus": null, "esxiOSRepository": null, "esxiSoftwareBundle": null, "esxiSoftwareComponent": null, "extractProgress": 0, "fileSizeInGigabytes": null, "filename": null, "id": "8aaa07b2992a323a01992bc015d30135", "jobId": null, "md5Hash": null, "minimal": false, "name": "Intelligent Catalog 50.390.00", "needsAttention": false, "password": null, "rcmapproved": false, "signature": null, "signedKeySourceLocation": null, "softwareBundles": [], "softwareComponents": [], "sourceLocation": null, "sourceType": null, "state": null, "updatedBy": null, "updatedDate": null, "userBundleCount": 0, "username": null}, "firmwareRepositoryId": "8aaa07b2992a323a01992bc015d30135", "id": "8aaa07af992e959c01992eb7197b0150", "individualTeardown": false, "jobDetails": null, "jobId": null, "licenseRepository": null, "licenseRepositoryId": null, "lifecycleMode": false, "lifecycleModeReasons": [], "noOp": false, "numberOfDeployments": 0, "operationData": null, "operationStatus": null, "operationType": "RETRY", "originalDeploymentId": null, "owner": "admin", "precalculatedDeviceHealth": null, "preconfigureSVM": false, "preconfigureSVMAndUpdate": false, "removeService": false, "retry": false, "scaleUp": false, "scheduleDate": null, "serviceTemplate": {"allUsersAllowed": true, "assignedUsers": [], "blockServiceOperationsMap": {}, "brownfieldTemplateType": "NONE", "category": "block", "clusterCount": 1, "components": [{"asmGUID": "scaleio-block-legacy-gateway", "brownfield": false, "cloned": false, "clonedFromAsmGuid": null, "clonedFromId": null, "componentID": "component-scaleio-gateway-1", "componentValid": {"messages": [], "valid": true}, "configFile": null, "helpText": null, "id": "92511015-2a1e-498b-8b93-41455253dabf", "identifier": null, "instances": 1, "ip": null, "manageFirmware": false, "managementIpAddress": null, "name": "block-legacy-gateway", "osPuppetCertName": null, "puppetCertName": "scaleio-block-legacy-gateway", "refId": null, "relatedComponents": {"068e82fc-3767-49ee-a052-f2d8cac50d87": "Storage Only Node-4", "37e5ab99-ee64-4122-9eb0-92c7d76b8233": "Storage Only Node", "73dda7ab-dc46-411a-aae4-99bdb0d0e47a": "Storage Only Node-2", "c01f69a4-a1f9-4bba-8471-15285db1f18e": "Storage Only Node-5", "fb7b47e0-5da0-497e-a579-98a9557e1682": "Storage Only Node-3"}, "resources": [], "serialNumber": null, "subType": "STORAGEONLY", "teardown": false, "type": "SCALEIO"}], "configuration": null, "createdBy": null, "createdDate": "2025-09-09T13:43:03.001+00:00", "draft": false, "firmwareRepository": null, "hideTemplateActive": false, "id": "8aaa07af992e959c01992eb7197b0150", "inConfiguration": false, "lastDeployedDate": null, "licenseRepository": null, "manageFirmware": true, "networks": [{"description": "", "destinationIpAddress": "10.230.45.0", "id": "8aaa2600992a26d601992c06ec8e0021", "name": "Data-345", "static": true, "staticNetworkConfiguration": {"dnsSuffix": "pie.lab.emc.com", "gateway": "10.230.45.1", "ipAddress": null, "ipRange": [{"endingIp": "10.230.45.30", "id": "8aaa2600992a26d601992c06ec8e0022", "role": null, "startingIp": "10.230.45.21"}], "primaryDns": "10.230.44.169", "secondaryDns": "10.230.44.170", "staticRoute": null, "subnet": "255.255.255.0"}, "type": "SCALEIO_DATA", "vlanId": 345}], "originalTemplateId": "e3deed3d-25ac-4154-8696-b65293213cfd", "sdnasCount": 0, "serverCount": 5, "serviceCount": 0, "storageCount": 0, "switchCount": 0, "templateDescription": "Storage Only 5 Node deployment using Erasure Coding", "templateLocked": false, "templateName": "SO NVMe Enabled Clone (8aaa07af992e959c01992eb7197b0150)", "templateType": "VxRack FLEX", "templateValid": {"messages": [], "valid": true}, "templateVersion": "5.0.0.0", "updatedBy": null, "updatedDate": null, "useDefaultCatalog": false, "vmCount": 0}, "servicesDeployed": "NONE", "status": "in_progress", "teardown": false, "teardownAfterCancel": false, "templateValid": true, "totalBatchCount": null, "totalNumOfSteps": null, "updateServerFirmware": true, "updatedBy": "system", "updatedDate": "2025-09-10T02:00:17.092+00:00", "useDefaultCatalog": false, "vds": false, "vms": null}]

allUsersAllowed

boolean

Whether the deployment is accessible to all users.

Returned: success

assignedUsers

list / elements=string

List of users assigned to this deployment.

Returned: success

brownfield

boolean

Indicates if this is a brownfield (existing infrastructure) deployment.

Returned: success

compliant

boolean

Indicates whether the deployment is compliant with its template.

Returned: success

configurationChange

boolean

Indicates if there has been a configuration change in the deployment.

Returned: success

createdBy

string

User who created the deployment.

Returned: success

createdDate

string

Timestamp when the deployment was created.

Returned: success

currentBatchCount

integer

Current batch number being processed in the deployment workflow.

Returned: success

currentStepCount

integer

Current step number within the current batch of the deployment.

Returned: success

currentStepMessage

string

Message or status detail for the current step in deployment.

Returned: success

customImage

string

Name of the custom image used for deployment.

Returned: success

deploymentDescription

string

Description of the deployment.

Returned: success

deploymentDevice

list / elements=string

List of devices involved in the deployment.

Returned: success

brownfield

boolean

Indicates if the device is part of a brownfield deployment.

Returned: success

brownfieldStatus

string

Status indicating brownfield applicability for the device.

Returned: success

boolean

Indicates if CloudLink is enabled on the device.

Returned: success

compliantState

string

Compliance state of the device (e.g., COMPLIANT, NON_COMPLIANT).

Returned: success

componentId

string

Component ID associated with the device.

Returned: success

currentIpAddress

string

Current IP address assigned to the device.

Returned: success

dasCache

boolean

Indicates if DAS cache is enabled on the device.

Returned: success

deviceGroupName

string

Name of the group to which the device belongs.

Returned: success

deviceHealth

string

Health status of the device (e.g., GREEN, YELLOW, RED).

Returned: success

deviceState

string

Current state of the device in the deployment lifecycle.

Returned: success

deviceType

string

Type of device (e.g., RackServer, Switch).

Returned: success

healthMessage

string

Detailed health message for the device.

Returned: success

ipAddress

string

IP address configured for the device.

Returned: success

logDump

string

Log dump information from the device.

Returned: success

model

string

Hardware model of the device.

Returned: success

puppetCertName

string

Puppet certificate name used for managing the device.

Returned: success

refId

string

Reference ID of the device in the system.

Returned: success

refType

string

Type of reference for the device.

Returned: success

serviceTag

string

Service tag identifier of the physical device.

Returned: success

status

string

Current operational status of the device.

Returned: success

statusEndTime

string

Timestamp when the current status ended.

Returned: success

statusMessage

string

Additional message explaining the current status.

Returned: success

statusStartTime

string

Timestamp when the current status began.

Returned: success

deploymentFinishedDate

string

Timestamp when the deployment was completed.

Returned: success

deploymentHealthStatusType

string

Aggregated health status of the deployment (e.g., green, yellow, red).

Returned: success

deploymentName

string

Deployment name.

Returned: success

deploymentScheduledDate

string

Scheduled start time for the deployment.

Returned: success

deploymentStartedDate

string

Timestamp when the deployment actually started.

Returned: success

deploymentValid

boolean

Indicates if the deployment configuration is valid.

Returned: success

deploymentValidationResponse

string

Detailed response from the validation process.

Returned: success

disruptiveFirmware

boolean

Indicates if firmware update is disruptive (requires reboot).

Returned: success

firmwareInit

boolean

Indicates if firmware initialization has started.

Returned: success

firmwareRepository

dictionary

The firmware repository.

Returned: success

downloadStatus

string

The download status.

Returned: success

rcmapproved

boolean

If RCM approved.

Returned: success

signature

string

The signature details.

Returned: success

firmwareRepositoryId

string

ID of the firmware repository used.

Returned: success

id

string

Deployment ID.

Returned: success

individualTeardown

boolean

Indicates if individual components can be torn down separately.

Returned: success

jobDetails

string

Details about the background job handling the deployment.

Returned: success

jobId

string

ID of the associated background job.

Returned: success

licenseRepository

string

License repository configuration used in deployment.

Returned: success

licenseRepositoryId

string

ID of the license repository used.

Returned: success

lifecycleMode

boolean

Indicates if the deployment is in lifecycle management mode.

Returned: success

lifecycleModeReasons

list / elements=string

List of reasons why lifecycle mode is active.

Returned: success

noOp

boolean

Indicates if the deployment is running in dry-run (no-op) mode.

Returned: success

numberOfDeployments

integer

Number of deployments associated with this record.

Returned: success

operationData

string

Additional data related to the current operation.

Returned: success

operationStatus

string

Status of the current operation (e.g., running, failed).

Returned: success

operationType

string

Type of operation being performed (e.g., RETRY, CREATE).

Returned: success

originalDeploymentId

string

ID of the original deployment if this is a retry or clone.

Returned: success

owner

string

Owner of the deployment.

Returned: success

precalculatedDeviceHealth

string

Pre-calculated health status of devices.

Returned: success

preconfigureSVM

boolean

Indicates if SVM (ScaleIO Volume Manager) should be preconfigured.

Returned: success

preconfigureSVMAndUpdate

boolean

Indicates if SVM should be preconfigured and updated.

Returned: success

removeService

boolean

Indicates if services should be removed during teardown.

Returned: success

retry

boolean

Indicates if this deployment is a retry of a previous attempt.

Returned: success

scaleUp

boolean

Indicates if this is a scale-up deployment.

Returned: success

scheduleDate

string

Date when the deployment is scheduled to run.

Returned: success

servicesDeployed

string

Status of services deployed (e.g., NONE, PARTIAL, ALL).

Returned: success

serviceTemplate

dictionary

Template used to define the structure and components of the service.

Returned: success

allUsersAllowed

boolean

Whether the template is accessible to all users.

Returned: success

assignedUsers

list / elements=string

List of users assigned to use this template.

Returned: success

brownfieldTemplateType

string

Type of brownfield support in the template.

Returned: success

category

string

Category of the service (e.g., block, compute).

Returned: success

clusterCount

integer

Number of clusters defined in the template.

Returned: success

components

list / elements=string

List of components included in the service template.

Returned: success

asmGUID

string

Unique identifier for the component in ASM.

Returned: success

brownfield

boolean

Indicates if the component supports brownfield deployment.

Returned: success

cloned

boolean

Indicates if the component was cloned from another.

Returned: success

clonedFromAsmGuid

string

ASM GUID of the source component if cloned.

Returned: success

clonedFromId

string

ID of the source component if cloned.

Returned: success

componentID

string

Internal ID of the component.

Returned: success

componentValid

dictionary

Validation result for the component.

Returned: success

messages

list / elements=string

List of validation messages.

Returned: success

valid

boolean

Whether the component is valid.

Returned: success

configFile

string

Path or name of the configuration file.

Returned: success

helpText

string

Help text describing the component.

Returned: success

id

string

Unique identifier for the component.

Returned: success

identifier

string

External identifier for the component.

Returned: success

instances

integer

Number of instances of this component.

Returned: success

ip

string

Static IP assigned to the component.

Returned: success

manageFirmware

boolean

Indicates if firmware management is enabled for this component.

Returned: success

managementIpAddress

string

IP address used for managing the component.

Returned: success

name

string

Name of the component.

Returned: success

osPuppetCertName

string

Puppet certificate name for the OS layer.

Returned: success

puppetCertName

string

Puppet certificate name for the component.

Returned: success

refId

string

Reference ID in external systems.

Returned: success

resources

list / elements=string

List of resources allocated to the component.

Returned: success

serialNumber

string

Serial number of the hardware component.

Returned: success

subType

string

Sub-type of the component (e.g., STORAGEONLY).

Returned: success

teardown

boolean

Indicates if the component should be removed on teardown.

Returned: success

type

string

Type of the component (e.g., SCALEIO).

Returned: success

configuration

string

Full configuration payload for the service.

Returned: success

createdDate

string

Timestamp when the template was created.

Returned: success

draft

boolean

Indicates if the template is a draft version.

Returned: success

hideTemplateActive

boolean

Indicates if the template is hidden from users.

Returned: success

id

string

Template ID.

Returned: success

inConfiguration

boolean

Indicates if the template is currently in use.

Returned: success

lastDeployedDate

string

Timestamp of the last deployment using this template.

Returned: success

licenseRepository

string

License repository associated with the template.

Returned: success

manageFirmware

boolean

Indicates if firmware updates are managed for this template.

Returned: success

networks

list / elements=string

List of network configurations in the template.

Returned: success

description

string

Description of the network.

Returned: success

destinationIpAddress

string

Destination IP range for routing.

Returned: success

id

string

Network ID.

Returned: success

name

string

Name of the network.

Returned: success

static

boolean

Indicates if the network uses static addressing.

Returned: success

staticNetworkConfiguration

dictionary

Static network settings.

Returned: success

dnsSuffix

string

DNS suffix for the network.

Returned: success

gateway

string

Default gateway IP.

Returned: success

ipAddress

string

Specific IP assigned.

Returned: success

ipRange

list / elements=string

Range of IPs available for allocation.

Returned: success

endingIp

string

Last IP in the range.

Returned: success

id

string

ID of the IP range.

Returned: success

role

string

Role of IPs in this range.

Returned: success

startingIp

string

First IP in the range.

Returned: success

primaryDns

string

Primary DNS server IP.

Returned: success

secondaryDns

string

Secondary DNS server IP.

Returned: success

staticRoute

string

Static route configuration.

Returned: success

subnet

string

Subnet mask in dotted decimal format.

Returned: success

type

string

Type of network (e.g., SCALEIO_DATA).

Returned: success

vlanId

integer

VLAN ID associated with the network.

Returned: success

originalTemplateId

string

ID of the base template if this is a derived version.

Returned: success

sdnasCount

integer

Number of SDNAS nodes in the template.

Returned: success

serverCount

integer

Number of servers defined in the template.

Returned: success

serviceCount

integer

Number of services in the template.

Returned: success

storageCount

integer

Number of storage units.

Returned: success

switchCount

integer

Number of switches included.

Returned: success

templateDescription

string

Description of the service template.

Returned: success

templateLocked

boolean

Indicates if the template is locked for editing.

Returned: success

templateName

string

Name of the service template.

Returned: success

templateType

string

Type of template (e.g., VxRack FLEX).

Returned: success

templateValid

dictionary

Validation status of the template.

Returned: success

messages

list / elements=string

List of validation messages.

Returned: success

valid

boolean

Whether the template is valid.

Returned: success

templateVersion

string

Version of the template.

Returned: success

updatedDate

string

Timestamp when the template was last updated.

Returned: success

useDefaultCatalog

boolean

Indicates if the default firmware catalog is used.

Returned: success

vmCount

integer

Number of virtual machines in the template.

Returned: success

status

string

The status of deployment.

Returned: success

teardown

boolean

Indicates if the deployment is scheduled for teardown.

Returned: success

teardownAfterCancel

boolean

Indicates if teardown should occur after cancellation.

Returned: success

templateValid

boolean

Indicates if the associated service template is valid.

Returned: success

totalBatchCount

integer

Total number of batches in the deployment workflow.

Returned: success

totalNumOfSteps

integer

Total number of steps across all batches.

Returned: success

updatedBy

string

User who last updated the deployment.

Returned: success

updatedDate

string

Timestamp when the deployment was last updated.

Returned: success

updateServerFirmware

boolean

Indicates if server firmware should be updated during deployment.

Returned: success

useDefaultCatalog

boolean

Indicates if the default firmware catalog is used.

Returned: success

vds

boolean

Indicates if Virtual Distributed Switches are used.

Returned: success

vms

list / elements=string

Virtual machine configurations or status.

Returned: success

Devices

list / elements=string

Details of devices.

Returned: always

Sample: [{"accelerationPoolId": null, "accelerationProps": null, "aggregatedState": "NeverFailed", "ataSecurityActive": false, "autoDetectMediaType": null, "cacheLookAheadActive": false, "capacity": 0, "capacityInMb": 1048576, "capacityLimitInKb": 1073479680, "deviceCurrentPathName": "/dev/sdf", "deviceGroupId": "d291d60100000000", "deviceOriginalPathName": "/dev/sdf", "deviceState": "Normal", "deviceType": "Unknown", "errorState": "None", "externalAccelerationType": "None", "fglNvdimmMetadataAmortizationX100": null, "fglNvdimmWriteCacheSize": null, "firmwareVersion": null, "id": "63efabfb00000004", "ledSetting": "Off", "links": [{"href": "/api/instances/Device::63efabfb00000004", "rel": "self"}], "logicalSectorSizeInBytes": 0, "longSuccessfulIos": {"longWindow": null, "mediumWindow": null, "shortWindow": null}, "maxCapacityInKb": 1073479680, "mediaFailing": false, "mediaType": "SSD", "modelName": null, "name": "sdf", "persistentChecksumState": "StateInvalid", "physicalSectorSizeInBytes": 0, "raidControllerSerialNumber": null, "rfcacheErrorDeviceDoesNotExist": false, "rfcacheProps": null, "sdsId": null, "serialNumber": null, "slotNumber": "N/A", "spSdsId": null, "ssdEndOfLifeState": "NeverFailed", "storageNodeId": "876859f300000000", "storagePoolId": null, "storageProps": null, "temperatureState": "NeverFailed", "usableCapacityInMb": 1048320, "vendorName": null, "writeCacheActive": false}]

accelerationPoolId

string

ID of the acceleration pool associated with the device.

Returned: success

accelerationProps

string

Acceleration properties of the device.

Returned: success

aggregatedState

string

Aggregated health state of the device (e.g., NeverFailed).

Returned: success

ataSecurityActive

boolean

Indicates whether ATA security is active on the device.

Returned: success

autoDetectMediaType

string

Indicates whether media type auto-detection is enabled.

Returned: success

cacheLookAheadActive

boolean

Indicates whether cache look-ahead is enabled for the device.

Returned: success

capacity

integer

Total capacity of the device (in KB or other unit, context-dependent).

Returned: success

capacityInMb

integer

Total capacity of the device in megabytes.

Returned: success

capacityLimitInKb

integer

Capacity limit of the device in kilobytes.

Returned: success

deviceCurrentPathName

string

Current device path name (e.g., /dev/sdf).

Returned: success

deviceGroupId

string

ID of the device group to which the device belongs.

Returned: success

deviceOriginalPathName

string

Original device path name at time of discovery.

Returned: success

deviceState

string

Current operational state of the device (e.g., Normal).

Returned: success

deviceType

string

Type of the device (e.g., Unknown, SSD).

Returned: success

errorState

string

Current error state of the device (e.g., None).

Returned: success

externalAccelerationType

string

Type of external acceleration used (e.g., None).

Returned: success

fglNvdimmMetadataAmortizationX100

string

Metadata amortization factor for FlashGuard Log (FGL) devices.

Returned: success

fglNvdimmWriteCacheSize

string

NVDIMM write cache size for FlashGuard Log (FGL) devices.

Returned: success

firmwareVersion

string

Firmware version of the device.

Returned: success

id

string

device id.

Returned: success

ledSetting

string

Current LED indicator setting of the device (e.g., Off).

Returned: success

list / elements=string

List of hypermedia links related to the device.

Returned: success

string

The URI of the linked resource.

Returned: success

string

The relation type of the link.

Returned: success

logicalSectorSizeInBytes

integer

Logical sector size of the device in bytes.

Returned: success

longSuccessfulIos

dictionary

Long-term successful I/O statistics for the device.

Returned: success

longWindow

string

Number of successful I/Os in the long time window.

Returned: success

mediumWindow

string

Number of successful I/Os in the medium time window.

Returned: success

shortWindow

string

Number of successful I/Os in the short time window.

Returned: success

maxCapacityInKb

integer

Maximum supported capacity of the device in kilobytes.

Returned: success

mediaFailing

boolean

Indicates whether the device media is failing.

Returned: success

mediaType

string

Type of media used in the device (e.g., SSD).

Returned: success

modelName

string

Model name of the device.

Returned: success

name

string

device name.

Returned: success

persistentChecksumState

string

State of persistent checksum on the device (e.g., StateInvalid).

Returned: success

physicalSectorSizeInBytes

integer

Physical sector size of the device in bytes.

Returned: success

raidControllerSerialNumber

string

Serial number of the RAID controller managing the device.

Returned: success

rfcacheErrorDeviceDoesNotExist

boolean

Indicates if there is an RFcache error due to missing device.

Returned: success

rfcacheProps

string

RFcache properties associated with the device.

Returned: success

sdsId

string

ID of the SDS (ScaleIO Data Server) managing the device.

Returned: success

serialNumber

string

Serial number of the device.

Returned: success

slotNumber

string

Physical slot number where the device is installed (e.g., N/A).

Returned: success

spSdsId

string

SDS ID specific to the storage pool.

Returned: success

ssdEndOfLifeState

string

SSD end-of-life status (e.g., NeverFailed).

Returned: success

storageNodeId

string

ID of the storage node hosting the device.

Returned: success

storagePoolId

string

ID of the storage pool to which the device is assigned.

Returned: success

storageProps

string

Storage-related properties of the device.

Returned: success

temperatureState

string

Temperature health state of the device (e.g., NeverFailed).

Returned: success

usableCapacityInMb

integer

Usable capacity of the device in megabytes.

Returned: success

vendorName

string

Manufacturer/vendor name of the device.

Returned: success

writeCacheActive

boolean

Indicates whether write cache is currently active on the device.

Returned: success

FirmwareRepository

list / elements=string

Details of all firmware repository.

Returned: when gather_subset is firmware_repository

Sample: [{"bundleCount": 54, "componentCount": 2783, "createdBy": "admin", "createdDate": "2025-08-26T06:46:30.994+00:00", "custom": false, "defaultCatalog": true, "deployments": [], "diskLocation": "https://xxxx", "downloadProgress": 100, "downloadStatus": "available", "esxiOSRepository": null, "esxiSoftwareBundle": null, "esxiSoftwareComponent": null, "extractProgress": 100, "fileSizeInGigabytes": 21.7, "filename": "catalog.xml", "id": "8aaa80a998e515080198e520d5520000", "jobId": "Job-a3129599-9702-4abc-b041-0724b82087bc", "md5Hash": null, "minimal": false, "name": "Intelligent Catalog 50.390.00", "needsAttention": false, "password": null, "rcmapproved": false, "signature": "Signed", "signedKeySourceLocation": null, "softwareBundles": [], "softwareComponents": [], "sourceLocation": "https://xxx.zip", "sourceType": "FILE", "state": "available", "updatedBy": "system", "updatedDate": "2025-09-03T05:52:58.636+00:00", "userBundleCount": 0, "username": ""}]

bundleCount

integer

Total number of bundles in the firmware repository.

Returned: success

componentCount

integer

Total number of software components in the firmware repository.

Returned: success

createdBy

string

User who created the firmware repository.

Returned: success

createdDate

string

Timestamp when the firmware repository was created.

Returned: success

custom

boolean

Indicates whether the firmware repository is a custom catalog.

Returned: success

defaultCatalog

boolean

Indicates whether this is the default firmware catalog.

Returned: success

deployments

list / elements=string

Deployments of the firmware repository.

Returned: success

diskLocation

string

Disk path or URL where the firmware repository is stored.

Returned: success

downloadProgress

integer

Progress percentage of the download process.

Returned: success

downloadStatus

string

Current status of the download (e.g., available).

Returned: success

esxiOSRepository

string

ESXi operating system repository, if applicable.

Returned: success

esxiSoftwareBundle

string

ESXi software bundle included in the repository.

Returned: success

esxiSoftwareComponent

string

ESXi software component included in the repository.

Returned: success

extractProgress

integer

Progress percentage of the extraction process.

Returned: success

filename

string

Name of the catalog file (e.g., catalog.xml).

Returned: success

fileSizeInGigabytes

float

Size of the firmware repository in gigabytes.

Returned: success

id

string

ID of the firmware repository.

Returned: success

jobId

string

Job ID associated with the firmware repository creation or update.

Returned: success

md5Hash

string

MD5 hash of the firmware repository file.

Returned: success

minimal

boolean

Indicates whether the repository is a minimal catalog.

Returned: success

name

string

Name of the firmware repository.

Returned: success

needsAttention

boolean

Indicates whether the repository requires user attention.

Returned: success

password

string

Password used to access the source location, if applicable.

Returned: success

rcmapproved

boolean

Indicates whether the repository is RCM (Recommended Configuration Management) approved.

Returned: success

signature

string

Signature status of the catalog (e.g., Signed).

Returned: success

signedKeySourceLocation

string

Source location of the signed key for catalog verification.

Returned: success

softwareBundles

list / elements=string

Software bundles of the firmware repository.

Returned: success

softwareComponents

list / elements=string

Software components of the firmware repository.

Returned: success

sourceLocation

string

Source location of the firmware repository.

Returned: success

sourceType

string

Type of source (e.g., FILE).

Returned: success

state

string

State of the firmware repository.

Returned: success

updatedBy

string

User who last updated the firmware repository.

Returned: success

updatedDate

string

Timestamp when the firmware repository was last updated.

Returned: success

userBundleCount

integer

Number of user-defined bundles in the repository.

Returned: success

username

string

Username used to access the source location.

Returned: success

ManagedDevices

list / elements=string

Details of all devices from inventory.

Returned: when gather_subset is managed_device

Sample: [{"chassisId": null, "compliance": "NONCOMPLIANT", "complianceCheckDate": "2025-09-04T16:00:51.857+00:00", "config": null, "cpuType": null, "credId": "e938b574-8a0d-4b20-aea6-e0dd557d766d", "currentIpAddress": "10.43.1.67", "customFirmware": false, "detailLink": {"href": "/AsmManager/ManagedDevice/scaleio-block-legacy-gateway", "rel": "describedby", "title": "scaleio-block-legacy-gateway", "type": null}, "deviceGroupList": {"deviceGroup": [{"createdBy": "admin", "createdDate": null, "groupDescription": null, "groupName": "Global", "groupSeqId": -1, "groupUserList": null, "link": null, "managedDeviceList": null, "updatedBy": null, "updatedDate": null}], "paging": null}, "deviceType": "scaleio", "discoverDeviceType": "SCALEIO", "discoveredDate": "2025-08-22T15:48:05.477+00:00", "displayName": "block-legacy-gateway", "esxiMaintMode": 0, "failuresCount": 0, "firmwareName": "Default Catalog - Intelligent Catalog 50.390.00", "flexosMaintMode": 0, "health": "GREEN", "healthMessage": "OK", "hostname": null, "inUse": false, "infraTemplateDate": null, "infraTemplateId": null, "inventoryDate": null, "ipAddress": "block-legacy-gateway", "lastJobs": null, "managedState": "MANAGED", "manufacturer": "Dell EMC", "memoryInGB": 0, "model": "PowerFlex Gateway", "needsAttention": false, "nics": 0, "numberOfCPUs": 0, "operatingSystem": "N/A", "osAdminCredential": null, "osImageType": null, "osIpAddress": null, "parsedFacts": null, "puppetCertName": "scaleio-block-legacy-gateway", "refId": "scaleio-block-legacy-gateway", "refType": null, "serverTemplateDate": null, "serverTemplateId": null, "serviceReferences": [], "serviceTag": "block-legacy-gateway", "state": "UPDATE_FAILED", "statusMessage": null, "svmAdminCredential": null, "svmImageType": null, "svmIpAddress": null, "svmName": null, "systemId": null, "vmList": []}]

chassisId

string

Chassis ID to which the device belongs, if applicable.

Returned: success

compliance

string

The compliance state of the device.

Returned: success

complianceCheckDate

string

Timestamp when the compliance check was last performed.

Returned: success

config

string

Configuration details of the device.

Returned: success

cpuType

string

Type of CPU installed on the device.

Returned: success

credId

string

Credential ID used for device authentication.

Returned: success

currentIpAddress

string

Current IP address assigned to the device.

Returned: success

customFirmware

boolean

Indicates whether custom firmware is applied to the device.

Returned: success

dictionary

Hypermedia link providing more details about the device.

Returned: success

string

The URI of the detailed resource.

Returned: success

string

The relation type of the link.

Returned: success

string

Human-readable title of the linked resource.

Returned: success

string

Media type of the linked resource.

Returned: success

deviceGroupList

dictionary

List of device groups the device belongs to.

Returned: success

deviceGroup

list / elements=string

List of device group entries.

Returned: success

createdBy

string

User who created the device group.

Returned: success

createdDate

string

Date when the device group was created.

Returned: success

groupDescription

string

Description of the device group.

Returned: success

groupName

string

Name of the device group.

Returned: success

groupSeqId

integer

Sequential ID of the device group.

Returned: success

groupUserList

string

List of users associated with the device group.

Returned: success

string

Link to the device group resource.

Returned: success

managedDeviceList

string

List of managed devices in the group.

Returned: success

updatedBy

string

User who last updated the device group.

Returned: success

updatedDate

string

Date when the device group was last updated.

Returned: success

paging

string

Pagination information for the device group list.

Returned: success

deviceType

string

Device Type.

Returned: success

discoverDeviceType

string

Discovered device type (e.g., SCALEIO).

Returned: success

discoveredDate

string

Timestamp when the device was discovered.

Returned: success

displayName

string

Display name of the device.

Returned: success

esxiMaintMode

integer

ESXi maintenance mode status of the device.

Returned: success

failuresCount

integer

Number of failures reported for the device.

Returned: success

firmwareName

string

Name of the firmware or catalog applied to the device.

Returned: success

flexosMaintMode

integer

FlexOS maintenance mode status of the device.

Returned: success

health

string

Overall health status of the device (e.g., GREEN).

Returned: success

healthMessage

string

Health status message (e.g., OK).

Returned: success

hostname

string

Hostname of the device.

Returned: success

infraTemplateDate

string

Date of the infrastructure template applied.

Returned: success

infraTemplateId

string

ID of the infrastructure template applied.

Returned: success

inUse

boolean

Indicates whether the device is currently in use.

Returned: success

inventoryDate

string

Timestamp when the device inventory was last updated.

Returned: success

ipAddress

string

IP address of the device.

Returned: success

lastJobs

string

List of recent jobs executed on the device.

Returned: success

managedState

string

The managed state of the device.

Returned: success

manufacturer

string

Manufacturer of the device (e.g., Dell EMC).

Returned: success

memoryInGB

integer

Total memory of the device in gigabytes.

Returned: success

model

string

Model name of the device (e.g., PowerFlex Gateway).

Returned: success

needsAttention

boolean

Indicates whether the device requires attention.

Returned: success

nics

integer

Number of network interface cards on the device.

Returned: success

numberOfCPUs

integer

Number of CPUs installed on the device.

Returned: success

operatingSystem

string

Operating system running on the device (e.g., N/A).

Returned: success

osAdminCredential

string

Credential for OS-level administrative access.

Returned: success

osImageType

string

Type of OS image used.

Returned: success

osIpAddress

string

IP address assigned to the OS instance.

Returned: success

parsedFacts

string

Parsed system facts collected from the device.

Returned: success

puppetCertName

string

Puppet certificate name for the device.

Returned: success

refId

string

Reference ID of the device.

Returned: success

refType

string

Reference type of the device.

Returned: success

serverTemplateDate

string

Date of the server template applied.

Returned: success

serverTemplateId

string

The ID of the server template.

Returned: success

serviceReferences

list / elements=string

List of service references associated with the device.

Returned: success

serviceTag

string

Service Tag.

Returned: success

state

string

The state of the device.

Returned: success

statusMessage

string

Additional status message for the device.

Returned: success

svmAdminCredential

string

Credential for SVM (Storage Virtual Machine) access.

Returned: success

svmImageType

string

Type of SVM image used.

Returned: success

svmIpAddress

string

IP address assigned to the SVM.

Returned: success

svmName

string

Name of the SVM.

Returned: success

systemId

string

The system ID.

Returned: success

vmList

list / elements=string

List of virtual machines associated with the device.

Returned: success

NVMe_Hosts

list / elements=string

Details of all NVMe hosts.

Returned: always

Sample: [{"hostOsFullType": "Generic", "hostType": "NVMeHost", "id": "fdc0ed2b00010000", "installedSoftwareVersionInfo": null, "kernelBuildNumber": null, "kernelVersion": null, "links": [{"href": "/api/instances/Host::fdc0ed2b00010000", "rel": "self"}], "maxNumPaths": 4, "maxNumSysPorts": 10, "mdmConnectionState": null, "mdmIpAddressesCurrent": null, "memoryAllocationFailure": null, "name": "nvme_host", "nqn": "nqn.2014-08.org.nvmexpress:uuid:e6e80a42-b1d3-5ec2-5ba6-d46d4df291234", "osType": null, "peerMdmId": null, "perfProfile": null, "sdcAgentActive": null, "sdcApproved": null, "sdcApprovedIps": null, "sdcGuid": null, "sdcIp": null, "sdcIps": null, "sdcType": null, "sdrId": null, "sdtId": null, "socketAllocationFailure": null, "softwareVersionInfo": null, "systemId": "815945c41cd8460f", "versionInfo": null}]

hostOsFullType

string

Full type of the host OS.

Returned: success

hostType

string

Type of the host.

Returned: success

id

string

ID of the NVMe host.

Returned: success

installedSoftwareVersionInfo

string

Installed software version information.

Returned: success

kernelBuildNumber

string

Kernel build number.

Returned: success

kernelVersion

string

Kernel version.

Returned: success

list / elements=string

Links related to the NVMe host.

Returned: success

string

Hyperlink reference.

Returned: success

string

Relation type.

Returned: success

max_num_paths

integer

Maximum number of paths per volume. Used to create or modify the NVMe host.

Returned: success

max_num_sys_ports

integer

Maximum number of ports per protection domain. Used to create or modify the NVMe host.

Returned: success

mdmConnectionState

string

MDM connection state.

Returned: success

mdmIpAddressesCurrent

list / elements=string

Current MDM IP addresses.

Returned: success

memoryAllocationFailure

string

Memory allocation failure status.

Returned: success

name

string

Name of the NVMe host.

Returned: success

nqn

string

NQN of the NVMe host. Used to create, get or modify the NVMe host.

Returned: success

osType

string

OS type.

Returned: success

peerMdmId

string

Peer MDM ID.

Returned: success

perfProfile

string

Performance profile.

Returned: success

sdcAgentActive

boolean

Whether the SDC agent is active.

Returned: success

sdcApproved

boolean

Whether an SDC has approved access to the system.

Returned: success

sdcApprovedIps

list / elements=string

SDC approved IPs.

Returned: success

sdcGuid

string

SDC GUID.

Returned: success

sdcIp

string

SDC IP address.

Returned: success

sdcIps

list / elements=string

SDC IP addresses.

Returned: success

sdcType

string

SDC type.

Returned: success

sdrId

string

SDR ID.

Returned: success

sdtId

string

SDT ID.

Returned: success

socketAllocationFailure

string

Socket allocation failure status.

Returned: success

softwareVersionInfo

string

Software version information.

Returned: success

systemId

string

ID of the system.

Returned: success

versionInfo

string

Version information.

Returned: success

Protection_Domains

list / elements=dictionary

Details of all protection domains.

Returned: always

Sample: [{"bandwidthLimitBgDevScanner": 15, "bandwidthLimitDoublyImpactedRebuild": 400, "bandwidthLimitNodeNetwork": 30, "bandwidthLimitOther": 10, "bandwidthLimitOverallIos": 500, "bandwidthLimitRebalance": 50, "bandwidthLimitSinglyImpactedRebuild": 500, "fglDefaultMetadataCacheSize": 0, "fglDefaultNumConcurrentWrites": 0, "fglMetadataCacheEnabled": false, "genType": "EC", "id": "e597f3dd00000000", "links": [{"href": "/api/instances/ProtectionDomain::e597f3dd00000000", "rel": "self"}], "mdmSdsNetworkDisconnectionsCounterParameters": {"longWindow": {"threshold": 700, "windowSizeInSec": 86400}, "mediumWindow": {"threshold": 500, "windowSizeInSec": 3600}, "shortWindow": {"threshold": 300, "windowSizeInSec": 60}}, "name": "PD_EC", "overallConcurrentIoLimit": 5, "overallIoNetworkThrottlingEnabled": false, "overallIoNetworkThrottlingInKbps": null, "protectedMaintenanceModeNetworkThrottlingEnabled": false, "protectedMaintenanceModeNetworkThrottlingInKbps": null, "protectionDomainState": "Active", "rebalanceEnabled": true, "rebalanceNetworkThrottlingEnabled": false, "rebalanceNetworkThrottlingInKbps": null, "rebuildEnabled": true, "rebuildNetworkThrottlingEnabled": false, "rebuildNetworkThrottlingInKbps": null, "rfcacheAccpId": null, "rfcacheEnabled": true, "rfcacheMaxIoSizeKb": 0, "rfcacheOpertionalMode": "WriteMiss", "rfcachePageSizeKb": 0, "rplCapAlertLevel": "invalid", "sdrSdsConnectivityInfo": {"clientServerConnStatus": "CLIENT_SERVER_CONN_STATUS_ALL_CONNECTED", "disconnectedClientId": null, "disconnectedClientName": null, "disconnectedServerId": null, "disconnectedServerIp": null, "disconnectedServerName": null}, "sdsConfigurationFailureCounterParameters": {"longWindow": {"threshold": 700, "windowSizeInSec": 86400}, "mediumWindow": {"threshold": 500, "windowSizeInSec": 3600}, "shortWindow": {"threshold": 300, "windowSizeInSec": 60}}, "sdsDecoupledCounterParameters": {"longWindow": {"threshold": 700, "windowSizeInSec": 86400}, "mediumWindow": {"threshold": 500, "windowSizeInSec": 3600}, "shortWindow": {"threshold": 300, "windowSizeInSec": 60}}, "sdsReceiveBufferAllocationFailuresCounterParameters": {"longWindow": {"threshold": 2000000, "windowSizeInSec": 86400}, "mediumWindow": {"threshold": 200000, "windowSizeInSec": 3600}, "shortWindow": {"threshold": 20000, "windowSizeInSec": 60}}, "sdsSdsNetworkDisconnectionsCounterParameters": {"longWindow": {"threshold": 700, "windowSizeInSec": 86400}, "mediumWindow": {"threshold": 500, "windowSizeInSec": 3600}, "shortWindow": {"threshold": 300, "windowSizeInSec": 60}}, "sdtSdsConnectivityInfo": {"clientServerConnStatus": "CLIENT_SERVER_CONN_STATUS_ALL_CONNECTED", "disconnectedClientId": null, "disconnectedClientName": null, "disconnectedServerId": null, "disconnectedServerIp": null, "disconnectedServerName": null}, "systemId": "815945c41cd8460f", "vtreeMigrationNetworkThrottlingEnabled": false, "vtreeMigrationNetworkThrottlingInKbps": null}]

bandwidthLimitBgDevScanner

integer

Bandwidth limit for background device scanner.

Returned: success

bandwidthLimitDoublyImpactedRebuild

integer

Bandwidth limit for doubly impacted rebuild operations.

Returned: success

bandwidthLimitNodeNetwork

integer

Bandwidth limit for node network.

Returned: success

bandwidthLimitOther

integer

Bandwidth limit for other I/O operations.

Returned: success

bandwidthLimitOverallIos

integer

Overall bandwidth limit for all I/O operations.

Returned: success

bandwidthLimitRebalance

integer

Bandwidth limit for rebalance operations.

Returned: success

bandwidthLimitSinglyImpactedRebuild

integer

Bandwidth limit for singly impacted rebuild operations.

Returned: success

fglDefaultMetadataCacheSize

integer

Default metadata cache size for fine-grained logging.

Returned: success

fglDefaultNumConcurrentWrites

integer

Default number of concurrent writes for fine-grained logging.

Returned: success

fglMetadataCacheEnabled

boolean

Whether metadata cache is enabled for fine-grained logging.

Returned: success

genType

string

Generation type of the protection domain (e.g., EC for Erasure Coding).

Returned: success

id

string

protection domain id.

Returned: success

list / elements=dictionary

Hypermedia links related to the protection domain.

Returned: success

string

The URI reference.

Returned: success

string

The relation type of the link.

Returned: success

mdmSdsNetworkDisconnectionsCounterParameters

dictionary

MDM-SDS network disconnection counter thresholds.

Returned: success

longWindow

dictionary

Long time window threshold settings.

Returned: success

threshold

integer

Disconnection threshold count.

Returned: success

windowSizeInSec

integer

Time window size in seconds.

Returned: success

mediumWindow

dictionary

Medium time window threshold settings.

Returned: success

threshold

integer

Disconnection threshold count.

Returned: success

windowSizeInSec

integer

Time window size in seconds.

Returned: success

shortWindow

dictionary

Short time window threshold settings.

Returned: success

threshold

integer

Disconnection threshold count.

Returned: success

windowSizeInSec

integer

Time window size in seconds.

Returned: success

name

string

protection domain name.

Returned: success

overallConcurrentIoLimit

integer

Overall concurrent I/O limit for the protection domain.

Returned: success

overallIoNetworkThrottlingEnabled

boolean

Whether overall I/O network throttling is enabled.

Returned: success

protectedMaintenanceModeNetworkThrottlingEnabled

boolean

Whether network throttling is enabled in protected maintenance mode.

Returned: success

protectionDomainState

string

Current state of the protection domain (e.g., Active).

Returned: success

rebalanceEnabled

boolean

Whether rebalance operations are enabled.

Returned: success

rebalanceNetworkThrottlingEnabled

boolean

Whether network throttling is enabled for rebalance operations.

Returned: success

rebuildEnabled

boolean

Whether rebuild operations are enabled.

Returned: success

rebuildNetworkThrottlingEnabled

boolean

Whether network throttling is enabled for rebuild operations.

Returned: success

rfcacheEnabled

boolean

Whether RF-Cache is enabled.

Returned: success

rfcacheMaxIoSizeKb

integer

Maximum I/O size in KB for RF-Cache.

Returned: success

rfcacheOpertionalMode

string

Operational mode of RF-Cache (e.g., WriteMiss).

Returned: success

rfcachePageSizeKb

integer

Page size in KB used by RF-Cache.

Returned: success

rplCapAlertLevel

string

Replication capacity alert level.

Returned: success

sdrSdsConnectivityInfo

dictionary

Connectivity information between SDR client and SDS server.

Returned: success

clientServerConnStatus

string

Status of client-server connection.

Returned: success

disconnectedClientId

string

ID of disconnected client (null if connected).

Returned: success

disconnectedClientName

string

Name of disconnected client (null if connected).

Returned: success

disconnectedServerId

string

ID of disconnected server (null if connected).

Returned: success

disconnectedServerIp

string

IP of disconnected server (null if connected).

Returned: success

disconnectedServerName

string

Name of disconnected server (null if connected).

Returned: success

sdsConfigurationFailureCounterParameters

dictionary

SDS configuration failure counter thresholds.

Returned: success

longWindow

dictionary

Long time window threshold settings.

Returned: success

threshold

integer

Failure threshold count.

Returned: success

windowSizeInSec

integer

Time window size in seconds.

Returned: success

mediumWindow

dictionary

Medium time window threshold settings.

Returned: success

threshold

integer

Failure threshold count.

Returned: success

windowSizeInSec

integer

Time window size in seconds.

Returned: success

shortWindow

dictionary

Short time window threshold settings.

Returned: success

threshold

integer

Failure threshold count.

Returned: success

windowSizeInSec

integer

Time window size in seconds.

Returned: success

sdsDecoupledCounterParameters

dictionary

SDS decoupled state counter thresholds.

Returned: success

longWindow

dictionary

Long time window threshold settings.

Returned: success

threshold

integer

Decoupled threshold count.

Returned: success

windowSizeInSec

integer

Time window size in seconds.

Returned: success

mediumWindow

dictionary

Medium time window threshold settings.

Returned: success

threshold

integer

Decoupled threshold count.

Returned: success

windowSizeInSec

integer

Time window size in seconds.

Returned: success

shortWindow

dictionary

Short time window threshold settings.

Returned: success

threshold

integer

Decoupled threshold count.

Returned: success

windowSizeInSec

integer

Time window size in seconds.

Returned: success

sdsReceiveBufferAllocationFailuresCounterParameters

dictionary

SDS receive buffer allocation failure counter thresholds.

Returned: success

longWindow

dictionary

Long time window threshold settings.

Returned: success

threshold

integer

Buffer allocation failure threshold.

Returned: success

windowSizeInSec

integer

Time window size in seconds.

Returned: success

mediumWindow

dictionary

Medium time window threshold settings.

Returned: success

threshold

integer

Buffer allocation failure threshold.

Returned: success

windowSizeInSec

integer

Time window size in seconds.

Returned: success

shortWindow

dictionary

Short time window threshold settings.

Returned: success

threshold

integer

Buffer allocation failure threshold.

Returned: success

windowSizeInSec

integer

Time window size in seconds.

Returned: success

sdsSdsNetworkDisconnectionsCounterParameters

dictionary

SDS-SDS network disconnection counter thresholds.

Returned: success

longWindow

dictionary

Long time window threshold settings.

Returned: success

threshold

integer

Disconnection threshold count.

Returned: success

windowSizeInSec

integer

Time window size in seconds.

Returned: success

mediumWindow

dictionary

Medium time window threshold settings.

Returned: success

threshold

integer

Disconnection threshold count.

Returned: success

windowSizeInSec

integer

Time window size in seconds.

Returned: success

shortWindow

dictionary

Short time window threshold settings.

Returned: success

threshold

integer

Disconnection threshold count.

Returned: success

windowSizeInSec

integer

Time window size in seconds.

Returned: success

sdtSdsConnectivityInfo

dictionary

Connectivity information between SDT and SDS.

Returned: success

clientServerConnStatus

string

Status of client-server connection.

Returned: success

disconnectedClientId

string

ID of disconnected client (null if connected).

Returned: success

disconnectedClientName

string

Name of disconnected client (null if connected).

Returned: success

disconnectedServerId

string

ID of disconnected server (null if connected).

Returned: success

disconnectedServerIp

string

IP of disconnected server (null if connected).

Returned: success

disconnectedServerName

string

Name of disconnected server (null if connected).

Returned: success

systemId

string

ID of the associated storage system.

Returned: success

vtreeMigrationNetworkThrottlingEnabled

boolean

Whether network throttling is enabled for vTree migration.

Returned: success

SDCs

list / elements=string

Details of storage data clients.

Returned: always

Sample: [{"hostOsFullType": null, "hostType": "SdcHost", "id": "fdc050eb00000000", "installedSoftwareVersionInfo": "R5_0.0.0", "kernelBuildNumber": null, "kernelVersion": "6.4.0", "links": [{"href": "/api/instances/Sdc::fdc050eb00000000", "rel": "self"}], "maxNumPaths": null, "maxNumSysPorts": null, "mdmConnectionState": "Connected", "mdmIpAddressesCurrent": false, "memoryAllocationFailure": null, "name": "SDC3", "nqn": null, "osType": "Linux", "peerMdmId": null, "perfProfile": "HighPerformance", "sdcAgentActive": false, "sdcApproved": true, "sdcApprovedIps": null, "sdcGuid": "89843E55-2B2A-42F7-A970-505467F81981", "sdcIp": "10.225.106.69", "sdcIps": ["10.225.106.69"], "sdcType": "AppSdc", "sdrId": null, "sdtId": null, "socketAllocationFailure": null, "softwareVersionInfo": "R5_0.0.0", "systemId": "815945c41cd8460f", "versionInfo": "R5_0.0.0"}]

hostOsFullType

string

Full operating system type of the storage data client.

Returned: success

hostType

string

Host type of the storage data client.

Returned: success

id

string

storage data client id.

Returned: success

installedSoftwareVersionInfo

string

Installed software version information on the SDC.

Returned: success

kernelBuildNumber

string

Kernel build number of the SDC’s operating system.

Returned: success

kernelVersion

string

Kernel version of the SDC’s operating system.

Returned: success

list / elements=string

List of hypermedia links related to the SDC.

Returned: success

string

The URI of the resource.

Returned: success

string

The relation type of the link.

Returned: success

maxNumPaths

string

Maximum number of paths allowed for the SDC.

Returned: success

maxNumSysPorts

string

Maximum number of system ports allowed for the SDC.

Returned: success

mdmConnectionState

string

Current MDM (Management Domain Manager) connection state of the SDC.

Returned: success

mdmIpAddressesCurrent

boolean

Indicates whether the MDM IP addresses are current.

Returned: success

memoryAllocationFailure

string

Indicates if there was a memory allocation failure on the SDC.

Returned: success

name

string

storage data client name.

Returned: success

nqn

string

NVMe Qualified Name used for NVMe-o-Fabrics connectivity.

Returned: success

osType

string

Operating system type of the SDC.

Returned: success

peerMdmId

string

Identifier of the peer MDM that the SDC is connected to.

Returned: success

perfProfile

string

Performance profile configured for the SDC.

Returned: success

sdcAgentActive

boolean

Indicates whether the SDC agent is currently active.

Returned: success

sdcApproved

boolean

Indicates whether the SDC is approved to connect to the system.

Returned: success

sdcApprovedIps

list / elements=string

List of approved IP addresses for the SDC.

Returned: success

sdcGuid

string

Globally unique identifier for the SDC.

Returned: success

sdcIp

string

Primary IP address of the SDC.

Returned: success

sdcIps

list / elements=string

List of all IP addresses associated with the SDC.

Returned: success

sdcType

string

Type of the SDC (e.g., AppSdc).

Returned: success

sdrId

string

Identifier of the SDR (Storage Data Resilience) associated with the SDC.

Returned: success

sdtId

string

Identifier of the SDT (Storage Data Tunnel) associated with the SDC.

Returned: success

socketAllocationFailure

string

Indicates if there was a socket allocation failure on the SDC.

Returned: success

softwareVersionInfo

string

Current software version running on the SDC.

Returned: success

systemId

string

Identifier of the system to which the SDC belongs.

Returned: success

versionInfo

string

Version information of the SDC software.

Returned: success

sdt

list / elements=string

Details of NVMe storage data targets.

Returned: when gather_subset is sdt

Sample: [{"authenticationError": "None", "certificateInfo": {"issuer": "/GN=MDM/CN=CA-db69bee9dc6c0d0f/L=Hopkinton/ST=Massachusetts/C=US/O=EMC/OU=ASD", "subject": "/GN=sdt-comp-1/CN=pie104074/L=Hopkinton/ST=Massachusetts/C=US/O=EMC/OU=ASD", "thumbprint": "51:5E:FB:ED:91:43:54:8C:46:C3:60:ED:AD:0A:60:5E:90:3E:30:2D", "validFrom": "Sep  8 15:37:05 2025 GMT", "validFromAsn1Format": "250908153705Z", "validTo": "Sep  7 16:37:05 2035 GMT", "validToAsn1Format": "350907163705Z"}, "discoveryPort": 8009, "faultSetId": null, "id": "19b7d6c700000001", "ipList": [{"ip": "10.2.3.4", "role": "StorageAndHost"}, {"ip": "10.1.2.3", "role": "StorageAndHost"}], "links": [{"href": "/api/instances/Sdt::19b7d6c700000001", "rel": "self"}], "maintenanceState": "NoMaintenance", "mdmConnectionState": "Connected", "membershipState": "Joined", "name": "sdt_pie104074.pie.lab.emc.com", "nvmePort": 4420, "nvme_hosts": [], "persistentDiscoveryControllersNum": 0, "protectionDomainId": "19af22f800000000", "sdtState": "Normal", "softwareVersionInfo": "R5_0.0.0", "storagePort": 12200, "systemId": "db69bee9dc6c0d0f"}]

authenticationError

string

The authentication error details of the SDT object.

Returned: success

certificateInfo

dictionary

The certificate information of the SDT object.

Returned: success

issuer

string

The issuer of the certificate.

Returned: success

subject

string

The subject of the certificate.

Returned: success

thumbprint

string

The thumbprint of the certificate.

Returned: success

validFrom

string

The date from which the certificate is valid.

Returned: success

validFromAsn1Format

string

The validity start date in ASN.1 format.

Returned: success

validTo

string

The date until which the certificate is valid.

Returned: success

validToAsn1Format

string

The validity end date in ASN.1 format.

Returned: success

discoveryPort

integer

The discovery port number of the SDT object.

Returned: success

faultSetId

string

The fault set ID associated with the SDT object.

Returned: success

id

string

The unique identifier of the SDT object.

Returned: success

ipList

list / elements=string

The list of IP addresses of the SDT object.

Returned: success

ip

string

The IP address of the SDT object.

Returned: success

role

string

The role associated with the IP address of the SDT object.

Returned: success

list / elements=string

Hyperlinks related to the SDT object.

Returned: success

string

The URL of the link.

Returned: success

string

The relation type of the link.

Returned: success

maintenanceState

string

The maintenance state of the SDT object.

Returned: success

mdmConnectionState

string

The MDM connection state of the SDT object.

Returned: success

membershipState

string

The membership state of the SDT object.

Returned: success

name

string

The name of the SDT object.

Returned: success

nvme_hosts

list / elements=string

The list of NVMe hosts associated with the SDT object.

Returned: success

controllerId

integer

The controller ID.

Returned: success

hostId

string

The host ID associated with the NVMe controller.

Returned: success

hostIp

string

The IP address of the host.

Returned: success

id

string

The unique identifier of the NVMe controller.

Returned: success

isAssigned

boolean

Indicates if the NVMe controller is assigned.

Returned: success

isConnected

boolean

Indicates if the NVMe controller is connected.

Returned: success

list / elements=string

Hyperlinks related to the NVMe controller.

Returned: success

string

The URL of the link.

Returned: success

string

The relation type of the link.

Returned: success

name

string

The name of the NVMe controller. Can be null.

Returned: success

sdtId

string

The SDT ID associated with the NVMe controller.

Returned: success

subsystem

string

The subsystem associated with the NVMe controller.

Returned: success

sysPortId

integer

The system port ID.

Returned: success

sysPortIp

string

The IP address of the system port.

Returned: success

nvmePort

integer

The NVMe port number of the SDT object.

Returned: success

persistentDiscoveryControllersNum

integer

Number of persistent discovery controllers.

Returned: success

protectionDomainId

string

The Protection Domain ID associated with the SDT object.

Returned: success

sdtState

string

The state of the SDT object.

Returned: success

softwareVersionInfo

string

The software version information of the SDT object.

Returned: success

storagePort

integer

The storage port number of the SDT object.

Returned: success

systemId

string

ID of the system.

Returned: success

ServiceTemplates

list / elements=string

Details of all service templates.

Returned: when gather_subset is service_template

Sample: [{"allUsersAllowed": false, "assignedUsers": [], "blockServiceOperationsMap": {}, "brownfieldTemplateType": "NONE", "category": "Sample Templates", "clusterCount": 1, "components": [{"asmGUID": null, "brownfield": false, "cloned": false, "clonedFromAsmGuid": null, "clonedFromId": null, "componentID": "component-scaleio-gateway-1", "componentValid": {"messages": [], "valid": true}, "configFile": null, "helpText": null, "id": "f9adcdba-e0e7-4977-938e-9e5ca626d037", "identifier": null, "instances": 1, "ip": null, "manageFirmware": false, "managementIpAddress": null, "name": "PowerFlex Cluster", "osPuppetCertName": null, "puppetCertName": null, "refId": null, "relatedComponents": {"db582229-d23e-4ce2-b242-ecfc17f1c16b": "Storage Only Node"}, "resources": [], "serialNumber": null, "subType": "STORAGEONLY", "teardown": false, "type": "SCALEIO"}], "configuration": null, "createdBy": "system", "createdDate": "2025-08-22T15:48:20.369+00:00", "draft": false, "firmwareRepository": null, "hideTemplateActive": true, "id": "4d0468be-6827-4c41-bbaf-01086de116a8", "inConfiguration": false, "lastDeployedDate": null, "licenseRepository": null, "manageFirmware": true, "networks": [{"description": "", "destinationIpAddress": "192.168.104.0", "id": "ff80808177f8823b0177f8ba236b0004", "name": "flex-data1", "static": true, "staticNetworkConfiguration": {"dnsSuffix": null, "gateway": null, "ipAddress": null, "ipRange": null, "primaryDns": null, "secondaryDns": null, "staticRoute": null, "subnet": "255.255.255.0"}, "type": "SCALEIO_DATA", "vlanId": 104}], "originalTemplateId": "ff80808177f880fc0177f883bf1e0027", "sdnasCount": 0, "serverCount": 4, "serviceCount": 0, "storageCount": 0, "switchCount": 0, "templateDescription": "Storage Only 4 Node deployment with 100Gb networking", "templateLocked": true, "templateName": "Mirroring - Storage 100Gb - 2 Data - LACP", "templateType": "VxRack FLEX", "templateValid": {"messages": [], "valid": true}, "templateVersion": "5.0.0-2956", "updatedBy": null, "updatedDate": null, "useDefaultCatalog": true, "vmCount": 0}]

allUsersAllowed

boolean

Indicates whether the template is available to all users.

Returned: success

assignedUsers

list / elements=string

List of users explicitly assigned to use this template.

Returned: success

brownfieldTemplateType

string

Type of brownfield deployment supported by the template (e.g., NONE).

Returned: success

category

string

The template category.

Returned: success

clusterCount

integer

Number of clusters defined in the template.

Returned: success

components

list / elements=string

List of components included in the service template.

Returned: success

asmGUID

string

ASM GUID of the component, if applicable.

Returned: success

brownfield

boolean

Indicates whether the component supports brownfield deployment.

Returned: success

cloned

boolean

Indicates whether the component is cloned from another.

Returned: success

clonedFromAsmGuid

string

ASM GUID of the source component if cloned.

Returned: success

clonedFromId

string

ID of the source component if cloned.

Returned: success

componentID

string

Unique identifier for the component.

Returned: success

componentValid

dictionary

Validation status of the component.

Returned: success

messages

list / elements=string

List of validation messages.

Returned: success

valid

boolean

Indicates whether the component is valid.

Returned: success

configFile

string

Configuration file associated with the component.

Returned: success

helpText

string

Help text or description for the component.

Returned: success

id

string

Unique ID of the component instance.

Returned: success

identifier

string

Identifier for the component.

Returned: success

instances

integer

Number of instances of this component.

Returned: success

ip

string

IP address assigned to the component.

Returned: success

manageFirmware

boolean

Indicates whether firmware management is enabled for the component.

Returned: success

managementIpAddress

string

Management IP address of the component.

Returned: success

name

string

Name of the component (e.g., PowerFlex Cluster).

Returned: success

osPuppetCertName

string

Puppet certificate name for the OS instance.

Returned: success

puppetCertName

string

Puppet certificate name for the component.

Returned: success

refId

string

Reference ID of the component.

Returned: success

resources

list / elements=string

List of resources associated with the component.

Returned: success

serialNumber

string

Serial number of the component.

Returned: success

subType

string

Subtype of the component (e.g., STORAGEONLY).

Returned: success

teardown

boolean

Indicates whether the component should be torn down.

Returned: success

type

string

Type of the component (e.g., SCALEIO).

Returned: success

configuration

string

Full configuration data of the service template.

Returned: success

createdBy

string

User who created the service template.

Returned: success

createdDate

string

Timestamp when the template was created.

Returned: success

draft

boolean

Indicates whether the template is a draft.

Returned: success

firmwareRepository

string

Firmware repository used by the template.

Returned: success

hideTemplateActive

boolean

Indicates whether the template is hidden from users.

Returned: success

id

string

Unique identifier of the service template.

Returned: success

inConfiguration

boolean

Indicates whether the template is currently being configured.

Returned: success

lastDeployedDate

string

Timestamp when the template was last deployed.

Returned: success

licenseRepository

string

License repository used by the template.

Returned: success

manageFirmware

boolean

Indicates whether firmware management is enabled for the template.

Returned: success

networks

list / elements=string

List of network configurations defined in the template.

Returned: success

description

string

Description of the network.

Returned: success

destinationIpAddress

string

Destination IP address range for the network.

Returned: success

id

string

Unique ID of the network.

Returned: success

name

string

Name of the network (e.g., flex-data1).

Returned: success

static

boolean

Indicates whether the network uses static configuration.

Returned: success

staticNetworkConfiguration

dictionary

Static network settings for the network.

Returned: success

dnsSuffix

string

DNS suffix for the network.

Returned: success

gateway

string

Gateway IP address.

Returned: success

ipAddress

string

Assigned IP address.

Returned: success

ipRange

string

Range of IP addresses.

Returned: success

primaryDns

string

Primary DNS server IP.

Returned: success

secondaryDns

string

Secondary DNS server IP.

Returned: success

staticRoute

string

Static routing configuration.

Returned: success

subnet

string

Subnet mask in dotted-decimal format.

Returned: success

type

string

Type of the network (e.g., SCALEIO_DATA).

Returned: success

vlanId

integer

VLAN ID associated with the network.

Returned: success

originalTemplateId

string

ID of the original template from which this was derived.

Returned: success

sdnasCount

integer

Number of SDNAS instances in the template.

Returned: success

serverCount

integer

Server count.

Returned: success

serviceCount

integer

Number of services defined in the template.

Returned: success

storageCount

integer

Number of storage components in the template.

Returned: success

switchCount

integer

Number of switch components in the template.

Returned: success

templateDescription

string

Template description.

Returned: success

templateLocked

boolean

Indicates whether the template is locked for editing.

Returned: success

templateName

string

Template name.

Returned: success

templateType

string

Template type.

Returned: success

templateValid

dictionary

Validation status of the entire template.

Returned: success

messages

list / elements=string

List of validation messages.

Returned: success

valid

boolean

Indicates whether the template is valid.

Returned: success

templateVersion

string

Template version.

Returned: success

updatedBy

string

User who last updated the template.

Returned: success

updatedDate

string

Timestamp when the template was last updated.

Returned: success

useDefaultCatalog

boolean

Indicates whether the default firmware catalog is used.

Returned: success

vmCount

integer

Number of virtual machines defined in the template.

Returned: success

Snapshot_Policies

list / elements=string

Details of snapshot policies.

Returned: always

Sample: [{"autoSnapshotCreationCadenceInMin": 5, "id": "dc095e4d00000000", "isLastAutoSnapshotDataTimeAccurate": null, "lastAutoSnapshotCreationFailureReason": "NR", "lastAutoSnapshotDataTime": null, "lastAutoSnapshotFailureInFirstLevel": false, "links": [{"href": "/api/instances/SnapshotPolicy::dc095e4d00000000", "rel": "self"}], "maxVTreeAutoSnapshots": 1, "name": "Sample_snap_policy_Ray", "nextAutoSnapshotCreationTime": 0, "numOfAutoSnapshots": 0, "numOfCreationFailures": 0, "numOfExpiredButLockedSnapshots": 0, "numOfLockedSnapshots": 0, "numOfRetainedSnapshotsPerLevel": [1], "numOfSourceVolumes": 0, "rcgId": null, "rcgName": null, "secureSnapshots": false, "snapshotAccessMode": "ReadOnly", "snapshotPolicyState": "Paused", "systemId": "815945c41cd8460f", "timeOfLastAutoSnapshot": 0, "timeOfLastAutoSnapshotCreationFailure": 0}]

autoSnapshotCreationCadenceInMin

integer

Interval in minutes between automatic snapshot creations.

Returned: success

id

string

snapshot policy id.

Returned: success

isLastAutoSnapshotDataTimeAccurate

string

Indicates whether the timestamp of the last auto-snapshot data is accurate.

Returned: success

lastAutoSnapshotCreationFailureReason

string

Reason code for the last automatic snapshot creation failure.

Returned: success

lastAutoSnapshotDataTime

string

Timestamp of the last auto-snapshot data creation.

Returned: success

lastAutoSnapshotFailureInFirstLevel

boolean

Indicates if the last automatic snapshot failed at the first level.

Returned: success

list / elements=string

List of hypermedia links related to the snapshot policy.

Returned: success

string

The URI of the linked resource.

Returned: success

string

The relation type of the link.

Returned: success

maxVTreeAutoSnapshots

integer

Maximum number of automatic snapshots allowed per VTree.

Returned: success

name

string

snapshot policy name.

Returned: success

nextAutoSnapshotCreationTime

integer

Timestamp (in seconds) of the next scheduled automatic snapshot.

Returned: success

numOfAutoSnapshots

integer

Total number of automatic snapshots created under this policy.

Returned: success

numOfCreationFailures

integer

Number of failed automatic snapshot creation attempts.

Returned: success

numOfExpiredButLockedSnapshots

integer

Number of snapshots that have expired but are still locked.

Returned: success

numOfLockedSnapshots

integer

Total number of snapshots currently locked.

Returned: success

numOfRetainedSnapshotsPerLevel

list / elements=integer

Number of snapshots retained per storage level.

Returned: success

numOfSourceVolumes

integer

Number of source volumes associated with this snapshot policy.

Returned: success

rcgId

string

Identifier of the replication consistency group (RCG) associated with the policy.

Returned: success

rcgName

string

Name of the replication consistency group (RCG) associated with the policy.

Returned: success

secureSnapshots

boolean

Indicates whether snapshots are secure (immutable).

Returned: success

snapshotAccessMode

string

Access mode of the created snapshots (e.g., ReadOnly).

Returned: success

snapshotPolicyState

string

Current state of the snapshot policy (e.g., Paused, Active).

Returned: success

systemId

string

Identifier of the system to which the snapshot policy belongs.

Returned: success

timeOfLastAutoSnapshot

integer

Timestamp (in seconds) of the last successfully created automatic snapshot.

Returned: success

timeOfLastAutoSnapshotCreationFailure

integer

Timestamp (in seconds) of the last automatic snapshot creation failure.

Returned: success

Storage_Pools

list / elements=string

Details of storage pools.

Returned: always

Sample: [{"addressSpaceUsage": "Normal", "addressSpaceUsageType": "TypeHardLimit", "backgroundScannerBWLimitKBps": null, "backgroundScannerMode": null, "bgScannerCompareErrorAction": "Invalid", "bgScannerReadErrorAction": "Invalid", "capacityAlertCriticalThreshold": 90, "capacityAlertHighThreshold": 80, "capacityUsageState": "Normal", "capacityUsageType": "NetCapacity", "checksumEnabled": false, "compressionMethod": "Normal", "dataLayout": "ErasureCoding", "deviceGroupId": "d291d60100000000", "externalAccelerationType": "None", "fglAccpId": null, "fglExtraCapacity": null, "fglMaxCompressionRatio": null, "fglMetadataSizeXx100": null, "fglNvdimmMetadataAmortizationX100": null, "fglNvdimmWriteCacheSizeInMb": null, "fglOverProvisioningFactor": null, "fglPerfProfile": null, "fglWriteAtomicitySize": null, "fragmentationEnabled": false, "genType": "EC", "id": "372743fc00000000", "links": [{"href": "/api/instances/StoragePool::372743fc00000000", "rel": "self"}], "mediaType": null, "name": "SP_EC", "numOfParallelRebuildRebalanceJobsPerDevice": null, "overProvisioningFactor": 0, "persistentChecksumBuilderLimitKb": null, "persistentChecksumEnabled": false, "persistentChecksumState": "StateInvalid", "persistentChecksumValidateOnRead": null, "physicalSizeGB": 4095, "protectedMaintenanceModeIoPriorityAppBwPerDeviceThresholdInKbps": null, "protectedMaintenanceModeIoPriorityAppIopsPerDeviceThreshold": null, "protectedMaintenanceModeIoPriorityBwLimitPerDeviceInKbps": null, "protectedMaintenanceModeIoPriorityNumOfConcurrentIosPerDevice": null, "protectedMaintenanceModeIoPriorityPolicy": null, "protectedMaintenanceModeIoPriorityQuietPeriodInMsec": null, "protectionDomainId": "e597f3dd00000000", "protectionScheme": "TwoPlusTwo", "rawSizeGB": 8190, "rebalanceEnabled": null, "rebalanceIoPriorityAppBwPerDeviceThresholdInKbps": null, "rebalanceIoPriorityAppIopsPerDeviceThreshold": null, "rebalanceIoPriorityBwLimitPerDeviceInKbps": null, "rebalanceIoPriorityNumOfConcurrentIosPerDevice": null, "rebalanceIoPriorityPolicy": null, "rebalanceIoPriorityQuietPeriodInMsec": null, "rebuildEnabled": null, "rebuildIoPriorityAppBwPerDeviceThresholdInKbps": null, "rebuildIoPriorityAppIopsPerDeviceThreshold": null, "rebuildIoPriorityBwLimitPerDeviceInKbps": null, "rebuildIoPriorityNumOfConcurrentIosPerDevice": null, "rebuildIoPriorityPolicy": null, "rebuildIoPriorityQuietPeriodInMsec": null, "replicationCapacityMaxRatio": null, "rmcacheWriteHandlingMode": "Invalid", "spClass": "Default", "spHealthState": "Protected", "sparePercentage": null, "statistics": [{"name": "avg_host_read_latency", "values": [0]}, {"name": "raw_used", "values": [13190918307840]}, {"name": "logical_used", "values": [0]}, {"name": "host_write_bandwidth", "values": [0]}, {"name": "host_write_iops", "values": [0]}, {"name": "storage_fe_write_bandwidth", "values": [0]}, {"name": "storage_fe_write_iops", "values": [0]}, {"name": "avg_fe_write_io_size", "values": [0]}, {"name": "storage_fe_read_bandwidth", "values": [0]}, {"name": "storage_fe_read_iops", "values": [0]}, {"name": "avg_fe_read_io_size", "values": [0]}, {"name": "utilization_ratio", "values": [0.008140671]}, {"name": "compression_reducible_ratio", "values": [0.0]}, {"name": "host_read_bandwidth", "values": [0]}, {"name": "host_read_iops", "values": [0]}, {"name": "data_reduction_ratio", "values": [0.0]}, {"name": "thin_provisioning_ratio", "values": ["0.8"]}, {"name": "avg_wrc_write_latency", "values": [0]}, {"name": "unreducible_data", "values": [0]}, {"name": "avg_wrc_read_latency", "values": [0]}, {"name": "storage_fe_read_latency", "values": [0]}, {"name": "over_provisioning_limit", "values": [4611686017353646080]}, {"name": "patterns_saving_ratio", "values": [0.0]}, {"name": "avg_host_write_latency", "values": [0]}, {"name": "storage_fe_write_latency", "values": [0]}, {"name": "logical_provisioned", "values": [42949672960]}, {"name": "efficiency_ratio", "values": ["0.8"]}, {"name": "storage_fe_trim_latency", "values": [0]}, {"name": "physical_system", "values": [53687091200]}, {"name": "data_reduction_reducible_ratio", "values": [0.0]}, {"name": "storage_fe_trim_bandwidth", "values": [0]}, {"name": "storage_fe_trim_iops", "values": [0]}, {"name": "avg_fe_trim_io_size", "values": [0]}, {"name": "compression_ratio", "values": [0.0]}, {"name": "reducible_ratio", "values": [1.0]}, {"name": "physical_used", "values": [0]}, {"name": "snapshot_saving_ratio", "values": [0.0]}, {"name": "physical_free", "values": [6541235191808]}, {"name": "host_trim_bandwidth", "values": [0]}, {"name": "host_trim_iops", "values": [0]}, {"name": "total_wrc_write_bandwidth", "values": [0]}, {"name": "total_wrc_write_iops", "values": [0]}, {"name": "avg_wrc_write_io_size", "values": [0]}, {"name": "total_wrc_read_bandwidth", "values": [0]}, {"name": "total_wrc_read_iops", "values": [0]}, {"name": "avg_wrc_read_io_size", "values": [0]}, {"name": "physical_total", "values": [6594922283008]}, {"name": "logical_owned", "values": [0]}, {"name": "patterns_saving_reducible_ratio", "values": [0.0]}, {"name": "avg_host_trim_latency", "values": [0]}], "useRfcache": false, "useRmcache": false, "vtreeMigrationIoPriorityAppBwPerDeviceThresholdInKbps": null, "vtreeMigrationIoPriorityAppIopsPerDeviceThreshold": null, "vtreeMigrationIoPriorityBwLimitPerDeviceInKbps": null, "vtreeMigrationIoPriorityNumOfConcurrentIosPerDevice": null, "vtreeMigrationIoPriorityPolicy": null, "vtreeMigrationIoPriorityQuietPeriodInMsec": null, "wrcDeviceGroupId": "d291d60100000000", "zeroPaddingEnabled": true}]

addressSpaceUsage

string

Address space usage level of the storage pool.

Returned: success

addressSpaceUsageType

string

Type of address space usage (e.g., hard limit or soft limit).

Returned: success

backgroundScannerBWLimitKBps

integer

Bandwidth limit in KBps for background scanner operations.

Returned: success

backgroundScannerMode

string

Mode of the background scanner (e.g., disabled, full, etc.).

Returned: success

bgScannerCompareErrorAction

string

Action to take when a compare error is detected during background scanning.

Returned: success

bgScannerReadErrorAction

string

Action to take when a read error is detected during background scanning.

Returned: success

capacityAlertCriticalThreshold

integer

Threshold percentage for triggering critical capacity alerts.

Returned: success

capacityAlertHighThreshold

integer

Threshold percentage for triggering high capacity alerts.

Returned: success

capacityUsageState

string

Current state of capacity usage (e.g., Normal, Critical).

Returned: success

capacityUsageType

string

Type of capacity usage metric being reported.

Returned: success

checksumEnabled

boolean

Indicates whether checksum is enabled for data integrity.

Returned: success

compressionMethod

string

Compression method used in the storage pool.

Returned: success

dataLayout

string

Data layout scheme used in the storage pool (e.g., ErasureCoding).

Returned: success

deviceGroupId

string

ID of the device group associated with the storage pool.

Returned: success

externalAccelerationType

string

Type of external acceleration used.

Returned: success

fglAccpId

string

Acceleration policy ID for FlashGuard Log (FGL) if applicable.

Returned: success

fglExtraCapacity

integer

Extra capacity allocated for FlashGuard Log.

Returned: success

fglMaxCompressionRatio

integer

Maximum compression ratio allowed for FlashGuard Log.

Returned: success

fglMetadataSizeXx100

integer

Metadata size for FlashGuard Log as a percentage (multiplied by 100).

Returned: success

fglNvdimmMetadataAmortizationX100

integer

NVDIMM metadata amortization factor for FlashGuard Log (multiplied by 100).

Returned: success

fglNvdimmWriteCacheSizeInMb

integer

Write cache size in MB for NVDIMM in FlashGuard Log.

Returned: success

fglOverProvisioningFactor

integer

Over-provisioning factor for FlashGuard Log.

Returned: success

fglPerfProfile

string

Performance profile setting for FlashGuard Log.

Returned: success

fglWriteAtomicitySize

integer

Write atomicity size for FlashGuard Log.

Returned: success

fragmentationEnabled

boolean

Indicates whether fragmentation is enabled in the storage pool.

Returned: success

genType

string

Generation type of the storage pool (e.g., EC for Erasure Coding).

Returned: success

id

string

ID of the storage pool under protection domain.

Returned: success

list / elements=string

HATEOAS links related to the storage pool.

Returned: success

string

URL reference for the link.

Returned: success

string

Relation type of the link (e.g., self).

Returned: success

mediaType

string

Type of devices in the storage pool.

Returned: success

name

string

Name of the storage pool under protection domain.

Returned: success

numOfParallelRebuildRebalanceJobsPerDevice

integer

Number of parallel rebuild and rebalance jobs allowed per device.

Returned: success

overProvisioningFactor

integer

Over-provisioning factor applied to the storage pool.

Returned: success

persistentChecksumBuilderLimitKb

integer

Limit in KB for persistent checksum builder operations.

Returned: success

persistentChecksumEnabled

boolean

Indicates whether persistent checksum is enabled.

Returned: success

persistentChecksumState

string

Current state of persistent checksum (e.g., StateInvalid, Valid).

Returned: success

persistentChecksumValidateOnRead

boolean

Whether to validate persistent checksum on read operations.

Returned: success

physicalSizeGB

integer

Physical size of the storage pool in gigabytes.

Returned: success

protectedMaintenanceModeIoPriorityAppBwPerDeviceThresholdInKbps

integer

Application bandwidth threshold per device in Kbps during protected maintenance mode.

Returned: success

protectedMaintenanceModeIoPriorityAppIopsPerDeviceThreshold

integer

Application IOPS threshold per device during protected maintenance mode.

Returned: success

protectedMaintenanceModeIoPriorityBwLimitPerDeviceInKbps

integer

Bandwidth limit per device in Kbps during protected maintenance mode.

Returned: success

protectedMaintenanceModeIoPriorityNumOfConcurrentIosPerDevice

integer

Maximum number of concurrent IOs per device during protected maintenance mode.

Returned: success

protectedMaintenanceModeIoPriorityPolicy

string

IO priority policy during protected maintenance mode.

Returned: success

protectedMaintenanceModeIoPriorityQuietPeriodInMsec

integer

Quiet period in milliseconds during protected maintenance mode.

Returned: success

protectionDomainId

string

ID of the protection domain in which pool resides.

Returned: success

protectionDomainName

string

Name of the protection domain in which pool resides.

Returned: success

protectionScheme

string

Data protection scheme used (e.g., TwoPlusTwo).

Returned: success

rawSizeGB

integer

Raw (unformatted) size of the storage pool in gigabytes.

Returned: success

rebalanceEnabled

boolean

Indicates whether rebalancing is enabled for the storage pool.

Returned: success

rebalanceIoPriorityAppBwPerDeviceThresholdInKbps

integer

Application bandwidth threshold per device in Kbps during rebalance.

Returned: success

rebalanceIoPriorityAppIopsPerDeviceThreshold

integer

Application IOPS threshold per device during rebalance.

Returned: success

rebalanceIoPriorityBwLimitPerDeviceInKbps

integer

Bandwidth limit per device in Kbps during rebalance.

Returned: success

rebalanceIoPriorityNumOfConcurrentIosPerDevice

integer

Maximum number of concurrent IOs per device during rebalance.

Returned: success

rebalanceIoPriorityPolicy

string

IO priority policy during rebalance operations.

Returned: success

rebalanceIoPriorityQuietPeriodInMsec

integer

Quiet period in milliseconds during rebalance operations.

Returned: success

rebuildEnabled

boolean

Indicates whether rebuilding is enabled for the storage pool.

Returned: success

rebuildIoPriorityAppBwPerDeviceThresholdInKbps

integer

Application bandwidth threshold per device in Kbps during rebuild.

Returned: success

rebuildIoPriorityAppIopsPerDeviceThreshold

integer

Application IOPS threshold per device during rebuild.

Returned: success

rebuildIoPriorityBwLimitPerDeviceInKbps

integer

Bandwidth limit per device in Kbps during rebuild.

Returned: success

rebuildIoPriorityNumOfConcurrentIosPerDevice

integer

Maximum number of concurrent IOs per device during rebuild.

Returned: success

rebuildIoPriorityPolicy

string

IO priority policy during rebuild operations.

Returned: success

rebuildIoPriorityQuietPeriodInMsec

integer

Quiet period in milliseconds during rebuild operations.

Returned: success

replicationCapacityMaxRatio

integer

Maximum replication capacity ratio allowed.

Returned: success

rmcacheWriteHandlingMode

string

Write handling mode for RMcache.

Returned: success

sparePercentage

integer

Percentage of spare capacity reserved in the storage pool.

Returned: success

spClass

string

Storage pool class (e.g., Default).

Returned: success

spHealthState

string

Health state of the storage pool (e.g., Protected).

Returned: success

statistics

list / elements=dictionary

List of performance and capacity statistics for the storage pool.

Returned: success

name

string

Name of the statistic (e.g., avg_host_read_latency).

Returned: success

values

list / elements=string

Values for the statistic.

Returned: success

useRfcache

boolean

Enable/Disable RFcache on a specific storage pool.

Returned: success

useRmcache

boolean

Enable/Disable RMcache on a specific storage pool.

Returned: success

vtreeMigrationIoPriorityAppBwPerDeviceThresholdInKbps

integer

Application bandwidth threshold per device in Kbps during vTree migration.

Returned: success

vtreeMigrationIoPriorityAppIopsPerDeviceThreshold

integer

Application IOPS threshold per device during vTree migration.

Returned: success

vtreeMigrationIoPriorityBwLimitPerDeviceInKbps

integer

Bandwidth limit per device in Kbps during vTree migration.

Returned: success

vtreeMigrationIoPriorityNumOfConcurrentIosPerDevice

integer

Maximum number of concurrent IOs per device during vTree migration.

Returned: success

vtreeMigrationIoPriorityPolicy

string

IO priority policy during vTree migration.

Returned: success

vtreeMigrationIoPriorityQuietPeriodInMsec

integer

Quiet period in milliseconds during vTree migration.

Returned: success

wrcDeviceGroupId

string

Write Reduction Cache (WRC) device group ID.

Returned: success

zeroPaddingEnabled

boolean

Indicates whether zero padding is enabled for the storage pool.

Returned: success

Volumes

list / elements=string

Details of volumes.

Returned: always

Sample: [{"accessModeLimit": "ReadWrite", "ancestorVolumeId": null, "autoSnapshotGroupId": null, "compressionMethod": "NotApplicable", "consistencyGroupId": null, "creationTime": 1757086835, "dataLayout": "ErasureCoding", "genType": "EC", "id": "ae4f49db00000000", "links": [{"href": "/api/instances/Volume::ae4f49db00000000", "rel": "self"}], "lockedAutoSnapshot": false, "lockedAutoSnapshotMarkedForRemoval": false, "managedBy": "ScaleIO", "mappedSdcInfo": [{"accessMode": "ReadWrite", "hostType": "SdcHost", "isDirectBufferMapping": false, "limitBwInMbps": 0, "limitIops": 0, "nqn": null, "sdcId": "e5282d9800000001", "sdcIp": "10.225.106.98", "sdcName": "SDC2"}], "name": "ans_dev_1", "notGenuineSnapshot": false, "nsid": 1, "originalExpiryTime": 0, "pairIds": null, "replicationJournalVolume": false, "replicationTimeStamp": 0, "retentionLevels": [], "secureSnapshotExpTime": 0, "sizeInKb": 10485760, "snplIdOfAutoSnapshot": null, "snplIdOfSourceVolume": "5026b97c00000000", "statistics": [{"name": "host_trim_bandwidth", "values": [0]}, {"name": "host_trim_iops", "values": [0]}, {"name": "avg_host_write_latency", "values": [0]}, {"name": "avg_host_read_latency", "values": [0]}, {"name": "logical_provisioned", "values": [10737418240]}, {"name": "host_read_bandwidth", "values": [0]}, {"name": "host_read_iops", "values": [0]}, {"name": "logical_used", "values": [0]}, {"name": "host_write_bandwidth", "values": [0]}, {"name": "host_write_iops", "values": [0]}, {"name": "avg_host_trim_latency", "values": [0]}], "storagePoolId": "ea96090d00000000", "timeStampIsAccurate": false, "useRmcache": false, "volumeClass": "defaultclass", "volumeReplicationState": "UnmarkedForReplication", "volumeType": "ThinProvisioned", "vtreeId": "c7c9baf500000000"}]

accessModeLimit

string

Access mode limit for the volume (e.g., ReadWrite).

Returned: success

ancestorVolumeId

string

ID of the ancestor volume, if this is a snapshot.

Returned: success

autoSnapshotGroupId

string

ID of the auto-snapshot group associated with the volume.

Returned: success

compressionMethod

string

Compression method used for the volume (e.g., NotApplicable).

Returned: success

consistencyGroupId

string

ID of the consistency group the volume belongs to.

Returned: success

creationTime

integer

Unix timestamp (in seconds) when the volume was created.

Returned: success

dataLayout

string

Data layout type of the volume (e.g., ErasureCoding).

Returned: success

genType

string

Generation type of the volume (e.g., EC).

Returned: success

id

string

Unique identifier of the volume.

Returned: success

list / elements=string

List of hypermedia links related to the volume.

Returned: success

string

URL reference for the link.

Returned: success

string

Relationship of the link (e.g., self, query).

Returned: success

lockedAutoSnapshot

boolean

Indicates whether the auto-snapshot is locked.

Returned: success

lockedAutoSnapshotMarkedForRemoval

boolean

Indicates whether the locked auto-snapshot is marked for removal.

Returned: success

managedBy

string

System or component managing the volume (e.g., ScaleIO).

Returned: success

mappedSdcInfo

list / elements=string

Information about SDCs (hosts) mapped to this volume.

Returned: success

accessMode

string

Access mode granted to the SDC (e.g., ReadWrite).

Returned: success

hostType

string

Type of host (e.g., SdcHost).

Returned: success

isDirectBufferMapping

boolean

Indicates whether direct buffer mapping is used.

Returned: success

limitBwInMbps

integer

Bandwidth limit in Mbps (0 means unlimited).

Returned: success

limitIops

integer

IOPS limit (0 means unlimited).

Returned: success

nqn

string

NVMe Qualified Name, if applicable.

Returned: success

sdcId

string

Unique ID of the SDC (host).

Returned: success

sdcIp

string

IP address of the SDC.

Returned: success

sdcName

string

Name of the SDC.

Returned: success

name

string

Name of the volume.

Returned: success

notGenuineSnapshot

boolean

Indicates whether the snapshot is not a genuine point-in-time copy.

Returned: success

nsid

integer

Namespace ID assigned to the volume.

Returned: success

originalExpiryTime

integer

Original expiry time for the volume or snapshot.

Returned: success

pairIds

string

List of paired volume IDs, if volume is part of a pair.

Returned: success

replicationJournalVolume

boolean

Indicates whether the volume is used as a journal for replication.

Returned: success

replicationTimeStamp

integer

Timestamp of the last replication event.

Returned: success

retentionLevels

list / elements=string

List of retention levels configured for the volume.

Returned: success

secureSnapshotExpTime

integer

Expiration time for secure snapshots.

Returned: success

sizeInKb

integer

Size of the volume in kilobytes.

Returned: success

snplIdOfAutoSnapshot

string

Snapshot policy ID associated with auto-snapshot.

Returned: success

snplIdOfSourceVolume

string

Snapshot policy ID of the source volume.

Returned: success

statistics

list / elements=string

List of performance and capacity statistics for the volume.

Returned: success

name

string

Name of the statistic (e.g., avg_host_read_latency).

Returned: success

values

list / elements=string

Values for the statistic.

Returned: success

storagePoolId

string

ID of the storage pool where the volume resides.

Returned: success

timeStampIsAccurate

boolean

Indicates whether the timestamp is accurate.

Returned: success

useRmcache

boolean

Indicates whether remote cache is enabled for the volume.

Returned: success

volumeClass

string

Class or QoS policy assigned to the volume.

Returned: success

volumeReplicationState

string

Replication state of the volume (e.g., UnmarkedForReplication).

Returned: success

volumeType

string

Type of the volume (e.g., ThinProvisioned).

Returned: success

vtreeId

string

ID of the VTree (virtual tree) to which the volume belongs.

Returned: success

Authors

  • Tao He (@taohe1012)