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

Note

This module is part of the dellemc.powerflex collection (version 2.6.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.

New in dellemc.powerflex 1.0.0

Synopsis

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

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

Requirements

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

  • A Dell PowerFlex storage system version 3.6 or later.

  • PyPowerFlex 1.14.0.

Parameters

Parameter

Comments

filters

list / elements=dictionary

List of filters to support filtered output for storage entities.

Each filter is a list of filter_key, filter_operator, filter_value.

Supports passing of multiple filters.

filter_key

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.

Volumes - vol.

Storage pools - storage_pool.

Protection domains - protection_domain.

SDCs - sdc.

SDSs - sds.

Snapshot policies - snapshot_policy.

Devices - device.

Replication consistency groups - rcg.

Replication pairs - replication_pair.

Fault Sets - fault_set.

Service templates - service_template.

Managed devices - managed_device.

Deployments - deployment.

FirmwareRepository - firmware_repository.

NVMe host - nvme_host

NVMe Storage Data Target - sdt.

Choices:

  • "vol"

  • "storage_pool"

  • "protection_domain"

  • "sdc"

  • "sds"

  • "snapshot_policy"

  • "device"

  • "rcg"

  • "replication_pair"

  • "fault_set"

  • "service_template"

  • "managed_device"

  • "deployment"

  • "firmware_repository"

  • "nvme_host"

  • "sdt"

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

added in dellemc.powerflex 2.3.0

Include software bundle entities.

Applicable when gather_subset is firmware_repository.

Choices:

  • false ← (default)

  • true

include_components

boolean

added in dellemc.powerflex 2.3.0

Include software component 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)

boolean

added in dellemc.powerflex 2.3.0

Include related entities.

Applicable when gather_subset is firmware_repository.

Choices:

  • false ← (default)

  • true

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 check_mode is supported.

  • 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 service_template, managed_device, deployment or firmware_repository.

  • 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:
    hostname: "{{ hostname }}"
    username: "{{ username }}"
    password: "{{ password }}"
    validate_certs: "{{ validate_certs }}"
    gather_subset:
      - vol
      - storage_pool
      - protection_domain
      - sdc
      - sds
      - snapshot_policy
      - device
      - rcg
      - replication_pair
      - fault_set
      - nvme_host
      - sdt

- name: Get a subset list of PowerFlex volumes
  dellemc.powerflex.info:
    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 deployment and resource provisioning info
  dellemc.powerflex.info:
    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:
    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:
    hostname: "{{ hostname }}"
    username: "{{ username }}"
    password: "{{ password }}"
    validate_certs: "{{ validate_certs }}"
    gather_subset:
      - firmware_repository

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

- name: Get the list of firmware repository with filter
  dellemc.powerflex.info:
    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_related: true
    include_bundles: true
    include_components: 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 }}"

- name: Get the list of NVMe hosts
  dellemc.powerflex.info:
    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 the list of NVMe Storage Data Target
  dellemc.powerflex.info:
    hostname: "{{ hostname }}"
    username: "{{ username }}"
    password: "{{ password }}"
    validate_certs: "{{ validate_certs }}"
    gather_subset:
      - sdt

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: "3.5"

Array_Details

dictionary

System entities of PowerFlex storage array.

Returned: always

Sample: {"addressSpaceUsage": "Normal", "authenticationMethod": "Native", "capacityAlertCriticalThresholdPercent": 90, "capacityAlertHighThresholdPercent": 80, "capacityTimeLeftInDays": "24", "cliPasswordAllowed": true, "daysInstalled": 66, "defragmentationEnabled": true, "enterpriseFeaturesEnabled": true, "id": "4a54a8ba6df0690f", "installId": "38622771228e56db", "isInitialLicense": true, "lastUpgradeTime": 0, "managementClientSecureCommunicationEnabled": true, "maxCapacityInGb": "Unlimited", "mdmCluster": {"clusterMode": "ThreeNodes", "clusterState": "ClusteredNormal", "goodNodesNum": 3, "goodReplicasNum": 2, "id": "5356091375512217871", "master": {"id": "6101582c2ca8db00", "ips": ["10.47.xxx.xxx"], "managementIPs": ["10.47.xxx.xxx"], "name": "node0", "opensslVersion": "OpenSSL 1.0.2k-fips  26 Jan 2017", "port": 9011, "role": "Manager", "status": "Normal", "versionInfo": "R3_6.0.0", "virtualInterfaces": ["ens160"]}, "slaves": [{"id": "23fb724015661901", "ips": ["10.47.xxx.xxx"], "managementIPs": ["10.47.xxx.xxx"], "opensslVersion": "OpenSSL 1.0.2k-fips  26 Jan 2017", "port": 9011, "role": "Manager", "status": "Normal", "versionInfo": "R3_6.0.0", "virtualInterfaces": ["ens160"]}], "tieBreakers": [{"id": "6ef27eb20d0c1202", "ips": ["10.47.xxx.xxx"], "managementIPs": ["10.47.xxx.xxx"], "opensslVersion": "N/A", "port": 9011, "role": "TieBreaker", "status": "Normal", "versionInfo": "R3_6.0.0"}]}, "mdmExternalPort": 7611, "mdmManagementPort": 6611, "mdmSecurityPolicy": "None", "showGuid": true, "swid": "", "systemVersionName": "DellEMC PowerFlex Version: R3_6.0.354", "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

dictionary

Maximum capacity in GB.

Returned: success

mdmCluster

dictionary

MDM cluster details.

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": true, "configurationChange": false, "createdBy": "admin", "createdDate": "2024-01-05T16:53:21.407+00:00", "currentBatchCount": null, "currentStepCount": null, "currentStepMessage": null, "customImage": "os_sles", "deploymentDescription": "Test-Update - K", "deploymentDevice": [{"brownfield": false, "brownfieldStatus": "NOT_APPLICABLE", "cloudLink": false, "compliantState": "COMPLIANT", "componentId": null, "currentIpAddress": "10.1.1.1", "dasCache": false, "deviceGroupName": null, "deviceHealth": "GREEN", "deviceState": "READY", "deviceType": "scaleio", "healthMessage": "OK", "ipAddress": "block-legacy-gateway", "logDump": null, "model": "PowerFlex Gateway", "puppetCertName": "scaleio-block-legacy-gateway", "refId": "scaleio-block-legacy-gateway", "refType": null, "serviceTag": "block-legacy-gateway", "status": null, "statusEndTime": null, "statusMessage": null, "statusStartTime": null}], "deploymentFinishedDate": null, "deploymentHealthStatusType": "green", "deploymentName": "Test-Update - K", "deploymentScheduledDate": null, "deploymentStartedDate": "2024-01-05T16:53:22.886+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, "embedded": false, "extractProgress": 0, "fileSizeInGigabytes": null, "filename": null, "id": "8aaa80658cd602e0018cd996a1c91bdc", "jobId": null, "md5Hash": null, "minimal": false, "name": "Intelligent Catalog 45.373.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": "8aaa80658cd602e0018cd996a1c91bdc", "id": "8aaa80658cd602e0018cda8b257f78ce", "individualTeardown": false, "jobDetails": null, "licenseRepository": null, "licenseRepositoryId": null, "lifecycleMode": false, "lifecycleModeReasons": [], "noOp": false, "numberOfDeployments": 0, "operationData": null, "operationStatus": null, "operationType": "NONE", "originalDeploymentId": null, "owner": "admin", "precalculatedDeviceHealth": null, "preconfigureSVM": false, "preconfigureSVMAndUpdate": false, "removeService": false, "retry": false, "scaleUp": false, "scheduleDate": null, "serviceTemplate": {"allUsersAllowed": true, "assignedUsers": [], "blockServiceOperationsMap": {"scaleio-block-legacy-gateway": {"blockServiceOperationsMap": {}}}, "brownfieldTemplateType": "NONE", "category": "block-only", "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": "6def7edd-bae2-4420-93bf-9ceb051bbb65", "identifier": null, "instances": 1, "ip": null, "manageFirmware": false, "managementIpAddress": null, "name": "block-legacy-gateway", "osPuppetCertName": null, "puppetCertName": "scaleio-block-legacy-gateway", "refId": null, "relatedComponents": {"625b0e17-9b91-4bc0-864c-d0111d42d8d0": "Node (Software Only)", "961a59eb-80c3-4a3a-84b7-2101e9831527": "Node (Software Only)-2", "bca710a5-7cdf-481e-b729-0b53e02873ee": "Node (Software Only)-3"}, "resources": [], "serialNumber": null, "subType": "STORAGEONLY", "teardown": false, "type": "SCALEIO"}], "configuration": null, "createdBy": null, "createdDate": "2024-01-05T16:53:22.083+00:00", "draft": false, "firmwareRepository": null, "id": "8aaa80658cd602e0018cda8b257f78ce", "inConfiguration": false, "lastDeployedDate": null, "licenseRepository": null, "manageFirmware": true, "networks": [{"description": "", "destinationIpAddress": "10.1.1.1", "id": "8aaa80648cd5fb9b018cda46e4e50000", "name": "mgmt", "static": true, "staticNetworkConfiguration": {"dnsSuffix": null, "gateway": "10.1.1.1", "ipAddress": null, "ipRange": [{"endingIp": "10.1.1.1", "id": "8aaa80648cd5fb9b018cda46e5080001", "role": null, "startingIp": "10.1.1.1"}], "primaryDns": "10.1.1.1", "secondaryDns": "10.1.1.1", "staticRoute": null, "subnet": "1.1.1.0"}, "type": "SCALEIO_MANAGEMENT", "vlanId": 850}], "originalTemplateId": "c44cb500-020f-4562-9456-42ec1eb5f9b2", "sdnasCount": 0, "serverCount": 3, "serviceCount": 0, "storageCount": 1, "switchCount": 0, "templateDescription": "Storage - Software Only deployment", "templateLocked": false, "templateName": "block-only (8aaa80658cd602e0018cda8b257f78ce)", "templateType": "VxRack FLEX", "templateValid": {"messages": [], "valid": true}, "templateVersion": "4.5.0.0", "updatedBy": null, "updatedDate": "2024-02-09T06:00:09.602+00:00", "useDefaultCatalog": false, "vmCount": 0}, "servicesDeployed": "NONE", "status": "complete", "teardown": false, "teardownAfterCancel": false, "templateValid": true, "totalBatchCount": null, "totalNumOfSteps": null, "updateServerFirmware": true, "updatedBy": "system", "updatedDate": "2024-02-11T17:00:05.657+00:00", "useDefaultCatalog": false, "vds": false, "vms": null}]

deploymentName

string

Deployment name.

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

id

string

Deployment ID.

Returned: success

status

string

The status of deployment.

Returned: success

Devices

list / elements=string

Details of devices.

Returned: always

Sample: [{"id": "b6efa59900000000", "name": "device230"}, {"id": "b6efa5fa00020000", "name": "device_node0"}, {"id": "b7f3a60900010000", "name": "device22"}]

id

string

device id.

Returned: success

name

string

device name.

Returned: success

Fault_Sets

list / elements=string

Details of fault sets.

Returned: always

Sample: [{"SDS": [], "id": "eb44b70500000000", "links": [{"href": "/api/instances/FaultSet::eb44b70500000000", "rel": "self"}, {"href": "/api/instances/FaultSet::eb44b70500000000/relationships/Statistics", "rel": "/api/FaultSet/relationship/Statistics"}, {"href": "/api/instances/FaultSet::eb44b70500000000/relationships/Sds", "rel": "/api/FaultSet/relationship/Sds"}, {"href": "/api/instances/ProtectionDomain::da721a8300000000", "rel": "/api/parent/relationship/protectionDomainId"}], "name": "at1zbs1t6cp2sds1d1fs1", "protectionDomainId": "da721a8300000000", "protectionDomainName": "fault_set_1"}, {"SDS": [], "id": "eb44b70700000002", "links": [{"href": "/api/instances/FaultSet::eb44b70700000002", "rel": "self"}, {"href": "/api/instances/FaultSet::eb44b70700000002/relationships/Statistics", "rel": "/api/FaultSet/relationship/Statistics"}, {"href": "/api/instances/FaultSet::eb44b70700000002/relationships/Sds", "rel": "/api/FaultSet/relationship/Sds"}, {"href": "/api/instances/ProtectionDomain::da721a8300000000", "rel": "/api/parent/relationship/protectionDomainId"}], "name": "at1zbs1t6cp2sds1d1fs3", "protectionDomainId": "da721a8300000000", "protectionDomainName": "fault_set_2"}]

id

string

device id.

Returned: success

name

string

device name.

Returned: success

protectionDomainId

string

The ID of the protection domain.

Returned: success

FirmwareRepository

list / elements=string

Details of all firmware repository.

Returned: when gather_subset is firmware_repository

Sample: [{"bundleCount": 0, "componentCount": 0, "createdBy": "admin", "createdDate": "2024-02-26T17:07:11.884+00:00", "custom": false, "defaultCatalog": false, "deployments": [], "diskLocation": "", "downloadProgress": 100, "downloadStatus": "error", "embedded": false, "extractProgress": 0, "fileSizeInGigabytes": 0.0, "filename": "", "id": "8aaa03a78de4b2a5018de662818d000b", "jobId": "Job-10d75a23-d801-4fdb-a2d0-7f6389ab75cf", "md5Hash": null, "minimal": true, "name": "https://192.168.0.1/artifactory/path/pfxmlogs-bvt-pfmp-swo-upgrade-402-to-451-56.tar.gz", "needsAttention": false, "password": "", "rcmapproved": false, "signature": "Unknown", "signedKeySourceLocation": null, "softwareBundles": [], "softwareComponents": [], "sourceLocation": "https://192.168.0.2/artifactory/path/pfxmlogs-bvt-pfmp-swo-upgrade-402-to-451-56.tar.gz", "sourceType": null, "state": "errors", "updatedBy": "system", "updatedDate": "2024-03-01T06:21:10.917+00:00", "userBundleCount": 0, "username": ""}]

deployments

list / elements=string

Deployments of the firmware repository.

Returned: success

id

string

ID of the firmware repository.

Returned: success

name

string

Name of the firmware repository.

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

state

string

State of the firmware repository.

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": "2024-02-05T18:31:31.213+00:00", "config": null, "cpuType": null, "credId": "bc97cefb-5eb4-4c20-8e39-d1a2b809c9f5", "currentIpAddress": "10.1.1.1", "customFirmware": false, "detailLink": {"href": "/AsmManager/ManagedDevice/softwareOnlyServer-10.1.1.1", "rel": "describedby", "title": "softwareOnlyServer-10.1.1.1", "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": "SoftwareOnlyServer", "discoverDeviceType": "SOFTWAREONLYSERVER_CENTOS", "discoveredDate": "2024-02-05T18:31:30.992+00:00", "displayName": "vpi1011-c1n1", "esxiMaintMode": 0, "failuresCount": 0, "firmwareName": "Default Catalog - PowerFlex 4.5.0.0", "flexosMaintMode": 0, "health": "RED", "healthMessage": "Inventory run failed.", "hostname": "vpi1011-c1n1", "inUse": false, "infraTemplateDate": null, "infraTemplateId": null, "inventoryDate": null, "ipAddress": "10.1.1.1", "lastJobs": null, "managedState": "UNMANAGED", "manufacturer": "VMware, Inc.", "memoryInGB": 0, "model": "VMware Virtual Platform", "needsAttention": false, "nics": 0, "numberOfCPUs": 0, "operatingSystem": "N/A", "osAdminCredential": null, "osImageType": null, "osIpAddress": null, "parsedFacts": null, "puppetCertName": "red_hat-10.1.1.1", "refId": "softwareOnlyServer-10.1.1.1", "refType": null, "serverTemplateDate": null, "serverTemplateId": null, "serviceReferences": [], "serviceTag": "VMware-42 15 a5 f9 65 e6 63 0e-36 79 59 73 7b 3a 68 cd-SW", "state": "READY", "statusMessage": null, "svmAdminCredential": null, "svmImageType": null, "svmIpAddress": null, "svmName": null, "systemId": null, "vmList": []}]

compliance

string

The compliance state of the device.

Returned: success

deviceType

string

Device Type.

Returned: success

managedState

string

The managed state of the device.

Returned: success

serverTemplateId

string

The ID of the server template.

Returned: success

serviceTag

string

Service Tag.

Returned: success

state

string

The state of the device.

Returned: success

systemId

string

The system ID.

Returned: success

NVMe_Hosts

list / elements=string

Details of all NVMe hosts.

Returned: always

Sample: [{"hostOsFullType": "Generic", "hostType": "NVMeHost", "id": "da8f60fd00010000", "installedSoftwareVersionInfo": null, "kernelBuildNumber": null, "kernelVersion": null, "links": [{"href": "/api/instances/Host::da8f60fd00010000", "rel": "self"}, {"href": "/api/instances/Host::da8f60fd00010000/relationships/Volume", "rel": "/api/Host/relationship/Volume"}, {"href": "/api/instances/Host::da8f60fd00010000/relationships/NvmeController", "rel": "/api/Host/relationship/NvmeController"}, {"href": "/api/instances/System::f4c3b7f5c48cb00f", "rel": "/api/parent/relationship/systemId"}], "maxNumPaths": 3, "maxNumSysPorts": 3, "mdmConnectionState": null, "mdmIpAddressesCurrent": null, "memoryAllocationFailure": null, "name": "example_nvme_host", "nqn": "nqn.org.nvmexpress:uuid", "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": "f4c3b7f5c48cb00f", "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

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

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=string

Details of all protection domains.

Returned: always

Sample: [{"id": "9300e90900000001", "name": "domain2"}, {"id": "9300c1f900000000", "name": "domain1"}]

id

string

protection domain id.

Returned: success

name

string

protection domain name.

Returned: success

Replication_Consistency_Groups

list / elements=string

Details of rcgs.

Returned: always

Sample: {"abstractState": "Ok", "activeLocal": true, "activeRemote": true, "currConsistMode": "Consistent", "disasterRecoveryState": "None", "error": 65, "failoverState": "None", "failoverType": "None", "freezeState": "Unfrozen", "id": "aadc17d500000000", "inactiveReason": 11, "lastSnapCreationRc": "SUCCESS", "lastSnapGroupId": "e58280b300000001", "lifetimeState": "Normal", "localActivityState": "Active", "name": "test_rcg", "pauseMode": "None", "peerMdmId": "6c3d94f600000000", "protectionDomainId": "b969400500000000", "remoteActivityState": "Active", "remoteDisasterRecoveryState": "None", "remoteId": "2130961a00000000", "remoteMdmId": "0e7a082862fedf0f", "remoteProtectionDomainId": "4eeb304600000000", "remoteProtectionDomainName": "domain1", "replicationDirection": "LocalToRemote", "rpoInSeconds": 30, "snapCreationInProgress": false, "targetVolumeAccessMode": "NoAccess", "type": "User"}

abstractState

string

The abstract state of the replication consistency group.

Returned: success

activeLocal

boolean

Whether the local replication consistency group is active.

Returned: success

activeRemote

boolean

Whether the remote replication consistency group is active

Returned: success

currConsistMode

string

The current consistency mode of the replication consistency group.

Returned: success

disasterRecoveryState

string

The state of disaster recovery of the local replication consistency group.

Returned: success

error

integer

The error code of the replication consistency group.

Returned: success

failoverState

string

The state of failover of the replication consistency group.

Returned: success

failoverType

string

The type of failover of the replication consistency group.

Returned: success

freezeState

string

The freeze state of the replication consistency group.

Returned: success

id

string

The ID of the replication consistency group.

Returned: success

inactiveReason

integer

The reason for the inactivity of the replication consistency group.

Returned: success

lastSnapCreationRc

integer

The return code of the last snapshot of the replication consistency group.

Returned: success

lastSnapGroupId

string

ID of the last snapshot of the replication consistency group.

Returned: success

lifetimeState

string

The Lifetime state of the replication consistency group.

Returned: success

localActivityState

string

The state of activity of the local replication consistency group.

Returned: success

name

string

The name of the replication consistency group.

Returned: success

pauseMode

string

The Lifetime state of the replication consistency group.

Returned: success

peerMdmId

string

The ID of the peer MDM of the replication consistency group.

Returned: success

protectionDomainId

string

The Protection Domain ID of the replication consistency group.

Returned: success

remoteActivityState

string

The state of activity of the remote replication consistency group..

Returned: success

remoteDisasterRecoveryState

string

The state of disaster recovery of the remote replication consistency group.

Returned: success

remoteId

string

The ID of the remote replication consistency group.

Returned: success

remoteMdmId

string

The ID of the remote MDM of the replication consistency group.

Returned: success

remoteProtectionDomainId

string

The ID of the remote Protection Domain.

Returned: success

remoteProtectionDomainName

string

The Name of the remote Protection Domain.

Returned: success

replicationDirection

string

The direction of the replication of the replication consistency group.

Returned: success

rpoInSeconds

integer

The RPO value of the replication consistency group in seconds.

Returned: success

snapCreationInProgress

boolean

Whether the process of snapshot creation of the replication consistency group is in progress or not.

Returned: success

targetVolumeAccessMode

string

The access mode of the target volume of the replication consistency group.

Returned: success

type

string

The type of the replication consistency group.

Returned: success

Replication_pairs

list / elements=string

Details of the replication pairs.

Returned: Always

Sample: {"copyType": "OnlineCopy", "id": "23aa0bc900000001", "initialCopyPriority": -1, "initialCopyState": "Done", "lifetimeState": "Normal", "localActivityState": "RplEnabled", "localVolumeId": "e2bc1fab00000008", "name": null, "peerSystemName": null, "remoteActivityState": "RplEnabled", "remoteCapacityInMB": 8192, "remoteId": "a058446700000001", "remoteVolumeId": "1cda7af20000000d", "remoteVolumeName": "vol", "replicationConsistencyGroupId": "e2ce036b00000002", "userRequestedPauseTransmitInitCopy": false}

copyType

string

The copy type of the replication pair.

Returned: success

id

string

The ID of the replication pair.

Returned: success

initialCopyState

string

The inital copy state of the replication pair.

Returned: success

localActivityState

string

The state of activity of the local replication pair.

Returned: success

localVolumeId

string

The ID of the local volume.

Returned: success

name

string

The name of the replication pair.

Returned: success

remoteActivityState

string

The state of activity of the remote replication pair.

Returned: success

remoteId

string

The ID of the remote replication pair.

Returned: success

replicationConsistencyGroupId

string

The ID of the replication consistency group.

Returned: success

SDCs

list / elements=string

Details of storage data clients.

Returned: always

Sample: [{"id": "07335d3d00000006", "name": "LGLAP203"}, {"id": "07335d3c00000005", "name": "LGLAP178"}, {"id": "0733844a00000003"}]

id

string

storage data client id.

Returned: success

name

string

storage data client name.

Returned: success

SDSs

list / elements=string

Details of storage data servers.

Returned: always

Sample: [{"id": "8f3bb0cc00000002", "name": "node0"}, {"id": "8f3bb0ce00000000", "name": "node1"}, {"id": "8f3bb15300000001", "name": "node22"}]

id

string

storage data server id.

Returned: success

name

string

storage data server name.

Returned: success

sdt

list / elements=string

Details of NVMe storage data targets.

Returned: when gather_subset is sdt

Sample: [{"authenticationError": "None", "certificateInfo": null, "discoveryPort": 8009, "faultSetId": null, "id": "8bddf18b00000000", "ipList": [{"ip": "10.1.1.1", "role": "HostOnly"}, {"ip": "10.1.1.2", "role": "StorageOnly"}], "links": [{"href": "/api/instances/Sdt::8bddf18b00000000", "rel": "self"}, {"href": "/api/instances/Sdt::8bddf18b00000000/relationships/Statistics", "rel": "/api/Sdt/relationship/Statistics"}, {"href": "/api/instances/ProtectionDomain::32a39aa600000000", "rel": "/api/parent/relationship/protectionDomainId"}], "maintenanceState": "NoMaintenance", "mdmConnectionState": "Connected", "membershipState": "Joined", "name": "Sdt-yulan3-pf460-svm-1", "nvmePort": 4420, "nvme_hosts": [{"controllerId": 1, "hostId": "1040d69e00010001", "hostIp": "10.0.1.1", "id": "cc00010001000002", "isAssigned": false, "isConnected": true, "links": [{"href": "/api/instances/NvmeController::cc00010001000002", "rel": "self"}], "name": null, "sdtId": "8bddf18b00000000", "subsystem": "Io", "sysPortId": 0, "sysPortIp": "10.1.1.1"}], "persistentDiscoveryControllersNum": 0, "protectionDomainId": "32a39aa600000000", "sdtState": "Normal", "softwareVersionInfo": "R4_5.2100.0", "storagePort": 12200, "systemId": "264ec85b3855280f"}]

authenticationError

string

The authentication error details of the SDT object.

Returned: success

certificateInfo

string

The certificate information of the SDT object.

Returned: success

discoveryPort

integer

The discovery port number of 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

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

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

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": "43dec024-85a9-4901-9e8e-fa0d3c417f7b", "identifier": null, "instances": 1, "ip": null, "manageFirmware": false, "managementIpAddress": null, "name": "PowerFlex Cluster", "osPuppetCertName": null, "puppetCertName": null, "refId": null, "relatedComponents": {"c5c46733-012c-4dca-af9b-af46d73d045a": "Storage Only Node"}, "resources": [], "serialNumber": null, "subType": "STORAGEONLY", "teardown": false, "type": "SCALEIO"}], "configuration": null, "createdBy": "system", "createdDate": "2024-01-04T19:47:23.534+00:00", "draft": false, "firmwareRepository": null, "id": "2434144f-7795-4245-a04b-6fcb771697d7", "inConfiguration": false, "lastDeployedDate": null, "licenseRepository": null, "manageFirmware": true, "networks": [{"description": "", "destinationIpAddress": "1.1.1.0", "id": "ff80808177f8823b0177f8bb82d80005", "name": "flex-data2", "static": true, "staticNetworkConfiguration": {"dnsSuffix": null, "gateway": null, "ipAddress": null, "ipRange": null, "primaryDns": null, "secondaryDns": null, "staticRoute": null, "subnet": "1.1.1.0"}, "type": "SCALEIO_DATA", "vlanId": 105}], "originalTemplateId": "ff80808177f880fc0177f883bf1e0027", "sdnasCount": 0, "serverCount": 4, "serviceCount": 0, "storageCount": 0, "switchCount": 0, "templateDescription": "Storage Only 4 Node deployment with 100Gb networking", "templateLocked": true, "templateName": "Storage- 100Gb", "templateType": "VxRack FLEX", "templateValid": {"messages": [], "valid": true}, "templateVersion": "4.5-213", "updatedBy": null, "updatedDate": null, "useDefaultCatalog": true, "vmCount": 0}]

category

string

The template category.

Returned: success

serverCount

integer

Server count.

Returned: success

templateDescription

string

Template description.

Returned: success

templateName

string

Template name.

Returned: success

templateType

string

Template type.

Returned: success

templateVersion

string

Template version.

Returned: success

Snapshot_Policies

list / elements=string

Details of snapshot policies.

Returned: always

Sample: [{"id": "2b380c5c00000000", "name": "sample_snap_policy"}, {"id": "2b380c5d00000001", "name": "sample_snap_policy_1"}]

id

string

snapshot policy id.

Returned: success

name

string

snapshot policy name.

Returned: success

Storage_Pools

list / elements=string

Details of storage pools.

Returned: always

Sample: [{"addressSpaceUsage": "Normal", "addressSpaceUsageType": "DeviceCapacityLimit", "backgroundScannerBWLimitKBps": 3072, "backgroundScannerMode": "DataComparison", "bgScannerCompareErrorAction": "ReportAndFix", "bgScannerReadErrorAction": "ReportAndFix", "capacityAlertCriticalThreshold": 90, "capacityAlertHighThreshold": 80, "capacityUsageState": "Normal", "capacityUsageType": "NetCapacity", "checksumEnabled": false, "compressionMethod": "Invalid", "dataLayout": "MediumGranularity", "externalAccelerationType": "None", "fglAccpId": null, "fglExtraCapacity": null, "fglMaxCompressionRatio": null, "fglMetadataSizeXx100": null, "fglNvdimmMetadataAmortizationX100": null, "fglNvdimmWriteCacheSizeInMb": null, "fglOverProvisioningFactor": null, "fglPerfProfile": null, "fglWriteAtomicitySize": null, "fragmentationEnabled": true, "id": "e0d8f6c900000000", "links": [{"href": "/api/instances/StoragePool::e0d8f6c900000000", "rel": "self"}, {"href": "/api/instances/StoragePool::e0d8f6c900000000 /relationships/Statistics", "rel": "/api/StoragePool/relationship/Statistics"}, {"href": "/api/instances/StoragePool::e0d8f6c900000000 /relationships/SpSds", "rel": "/api/StoragePool/relationship/SpSds"}, {"href": "/api/instances/StoragePool::e0d8f6c900000000 /relationships/Volume", "rel": "/api/StoragePool/relationship/Volume"}, {"href": "/api/instances/StoragePool::e0d8f6c900000000 /relationships/Device", "rel": "/api/StoragePool/relationship/Device"}, {"href": "/api/instances/StoragePool::e0d8f6c900000000 /relationships/VTree", "rel": "/api/StoragePool/relationship/VTree"}, {"href": "/api/instances/ProtectionDomain::9300c1f900000000", "rel": "/api/parent/relationship/protectionDomainId"}], "mediaType": "HDD", "name": "pool1", "numOfParallelRebuildRebalanceJobsPerDevice": 2, "persistentChecksumBuilderLimitKb": 3072, "persistentChecksumEnabled": true, "persistentChecksumState": "Protected", "persistentChecksumValidateOnRead": false, "protectedMaintenanceModeIoPriorityAppBwPerDeviceThresholdInKbps": null, "protectedMaintenanceModeIoPriorityAppIopsPerDeviceThreshold": null, "protectedMaintenanceModeIoPriorityBwLimitPerDeviceInKbps": 10240, "protectedMaintenanceModeIoPriorityNumOfConcurrentIosPerDevice": 1, "protectedMaintenanceModeIoPriorityPolicy": "limitNumOfConcurrentIos", "protectedMaintenanceModeIoPriorityQuietPeriodInMsec": null, "protectionDomainId": "9300c1f900000000", "protectionDomainName": "domain1", "rebalanceEnabled": true, "rebalanceIoPriorityAppBwPerDeviceThresholdInKbps": null, "rebalanceIoPriorityAppIopsPerDeviceThreshold": null, "rebalanceIoPriorityBwLimitPerDeviceInKbps": 10240, "rebalanceIoPriorityNumOfConcurrentIosPerDevice": 1, "rebalanceIoPriorityPolicy": "favorAppIos", "rebalanceIoPriorityQuietPeriodInMsec": null, "rebuildEnabled": true, "rebuildIoPriorityAppBwPerDeviceThresholdInKbps": null, "rebuildIoPriorityAppIopsPerDeviceThreshold": null, "rebuildIoPriorityBwLimitPerDeviceInKbps": 10240, "rebuildIoPriorityNumOfConcurrentIosPerDevice": 1, "rebuildIoPriorityPolicy": "limitNumOfConcurrentIos", "rebuildIoPriorityQuietPeriodInMsec": null, "replicationCapacityMaxRatio": 32, "rmcacheWriteHandlingMode": "Cached", "sparePercentage": 10, "statistics": {"BackgroundScannedInMB": 3466920, "activeBckRebuildCapacityInKb": 0, "activeEnterProtectedMaintenanceModeCapacityInKb": 0, "aggregateCompressionLevel": "Uncompressed", "atRestCapacityInKb": 1248256, "backgroundScanCompareErrorCount": 0, "backgroundScanFixedCompareErrorCount": 0, "bckRebuildReadBwc": {"numOccured": 0, "numSeconds": 0, "totalWeightInKb": 0}, "bckRebuildWriteBwc": {"numOccured": 0, "numSeconds": 0, "totalWeightInKb": 0}, "capacityAvailableForVolumeAllocationInKb": 369098752, "capacityInUseInKb": 2496512, "capacityInUseNoOverheadInKb": 2496512, "capacityLimitInKb": 845783040, "compressedDataCompressionRatio": 0.0, "compressionRatio": 1.0, "currentFglMigrationSizeInKb": 0, "deviceIds": [], "enterProtectedMaintenanceModeCapacityInKb": 0, "enterProtectedMaintenanceModeReadBwc": {"numOccured": 0, "numSeconds": 0, "totalWeightInKb": 0}, "enterProtectedMaintenanceModeWriteBwc": {"numOccured": 0, "numSeconds": 0, "totalWeightInKb": 0}, "exitProtectedMaintenanceModeReadBwc": {"numOccured": 0, "numSeconds": 0, "totalWeightInKb": 0}, "exitProtectedMaintenanceModeWriteBwc": {"numOccured": 0, "numSeconds": 0, "totalWeightInKb": 0}, "exposedCapacityInKb": 0, "failedCapacityInKb": 0, "fwdRebuildReadBwc": {"numOccured": 0, "numSeconds": 0, "totalWeightInKb": 0}, "fwdRebuildWriteBwc": {"numOccured": 0, "numSeconds": 0, "totalWeightInKb": 0}, "inMaintenanceCapacityInKb": 0, "inMaintenanceVacInKb": 0, "inUseVacInKb": 184549376, "inaccessibleCapacityInKb": 0, "logWrittenBlocksInKb": 0, "maxCapacityInKb": 845783040, "migratingVolumeIds": [], "migratingVtreeIds": [], "movingCapacityInKb": 0, "netCapacityInUseInKb": 1248256, "normRebuildCapacityInKb": 0, "normRebuildReadBwc": {"numOccured": 0, "numSeconds": 0, "totalWeightInKb": 0}, "normRebuildWriteBwc": {"numOccured": 0, "numSeconds": 0, "totalWeightInKb": 0}, "numOfDeviceAtFaultRebuilds": 0, "numOfDevices": 3, "numOfIncomingVtreeMigrations": 0, "numOfVolumes": 8, "numOfVolumesInDeletion": 0, "numOfVtrees": 8, "overallUsageRatio": 73.92289, "pendingBckRebuildCapacityInKb": 0, "pendingEnterProtectedMaintenanceModeCapacityInKb": 0, "pendingExitProtectedMaintenanceModeCapacityInKb": 0, "pendingFwdRebuildCapacityInKb": 0, "pendingMovingCapacityInKb": 0, "pendingMovingInBckRebuildJobs": 0, "persistentChecksumBuilderProgress": 100.0, "persistentChecksumCapacityInKb": 414720, "primaryReadBwc": {"numOccured": 0, "numSeconds": 0, "totalWeightInKb": 0}, "primaryReadFromDevBwc": {"numOccured": 0, "numSeconds": 0, "totalWeightInKb": 0}, "primaryReadFromRmcacheBwc": {"numOccured": 0, "numSeconds": 0, "totalWeightInKb": 0}, "primaryVacInKb": 92274688, "primaryWriteBwc": {"numOccured": 0, "numSeconds": 0, "totalWeightInKb": 0}, "protectedCapacityInKb": 2496512, "protectedVacInKb": 184549376, "provisionedAddressesInKb": 2496512, "rebalanceCapacityInKb": 0, "rebalanceReadBwc": {"numOccured": 0, "numSeconds": 0, "totalWeightInKb": 0}, "rebalanceWriteBwc": {"numOccured": 0, "numSeconds": 0, "totalWeightInKb": 0}, "rfacheReadHit": 0, "rfacheWriteHit": 0, "rfcacheAvgReadTime": 0, "rfcacheAvgWriteTime": 0, "rfcacheIoErrors": 0, "rfcacheIosOutstanding": 0, "rfcacheIosSkipped": 0, "rfcacheReadMiss": 0, "rmPendingAllocatedInKb": 0, "rmPendingThickInKb": 0, "rplJournalCapAllowed": 0, "rplTotalJournalCap": 0, "rplUsedJournalCap": 0, "secondaryReadBwc": {"numOccured": 0, "numSeconds": 0, "totalWeightInKb": 0}, "secondaryReadFromDevBwc": {"numOccured": 0, "numSeconds": 0, "totalWeightInKb": 0}, "secondaryReadFromRmcacheBwc": {"numOccured": 0, "numSeconds": 0, "totalWeightInKb": 0}, "secondaryVacInKb": 92274688, "secondaryWriteBwc": {"numOccured": 0, "numSeconds": 0, "totalWeightInKb": 0}, "semiProtectedCapacityInKb": 0, "semiProtectedVacInKb": 0, "snapCapacityInUseInKb": 0, "snapCapacityInUseOccupiedInKb": 0, "snapshotCapacityInKb": 0, "spSdsIds": ["abdfe71b00030001", "abdce71d00040001", "abdde71e00050001"], "spareCapacityInKb": 84578304, "targetOtherLatency": {"numOccured": 0, "numSeconds": 0, "totalWeightInKb": 0}, "targetReadLatency": {"numOccured": 0, "numSeconds": 0, "totalWeightInKb": 0}, "targetWriteLatency": {"numOccured": 0, "numSeconds": 0, "totalWeightInKb": 0}, "tempCapacityInKb": 0, "tempCapacityVacInKb": 0, "thickCapacityInUseInKb": 0, "thinAndSnapshotRatio": 73.92289, "thinCapacityAllocatedInKm": 184549376, "thinCapacityInUseInKb": 0, "thinUserDataCapacityInKb": 2496512, "totalFglMigrationSizeInKb": 0, "totalReadBwc": {"numOccured": 0, "numSeconds": 0, "totalWeightInKb": 0}, "totalWriteBwc": {"numOccured": 0, "numSeconds": 0, "totalWeightInKb": 0}, "trimmedUserDataCapacityInKb": 0, "unreachableUnusedCapacityInKb": 0, "unusedCapacityInKb": 758708224, "userDataCapacityInKb": 2496512, "userDataCapacityNoTrimInKb": 2496512, "userDataReadBwc": {"numOccured": 0, "numSeconds": 0, "totalWeightInKb": 0}, "userDataSdcReadLatency": {"numOccured": 0, "numSeconds": 0, "totalWeightInKb": 0}, "userDataSdcTrimLatency": {"numOccured": 0, "numSeconds": 0, "totalWeightInKb": 0}, "userDataSdcWriteLatency": {"numOccured": 0, "numSeconds": 0, "totalWeightInKb": 0}, "userDataTrimBwc": {"numOccured": 0, "numSeconds": 0, "totalWeightInKb": 0}, "userDataWriteBwc": {"numOccured": 0, "numSeconds": 0, "totalWeightInKb": 0}, "volMigrationReadBwc": {"numOccured": 0, "numSeconds": 0, "totalWeightInKb": 0}, "volMigrationWriteBwc": {"numOccured": 0, "numSeconds": 0, "totalWeightInKb": 0}, "volumeAddressSpaceInKb": "922XXXXX", "volumeAllocationLimitInKb": "3707XXXXX", "volumeIds": ["456afc7900XXXXXXXX"], "vtreeAddresSpaceInKb": 92274688, "vtreeIds": ["32b1681bXXXXXXXX"]}, "useRfcache": false, "useRmcache": false, "vtreeMigrationIoPriorityAppBwPerDeviceThresholdInKbps": null, "vtreeMigrationIoPriorityAppIopsPerDeviceThreshold": null, "vtreeMigrationIoPriorityBwLimitPerDeviceInKbps": 10240, "vtreeMigrationIoPriorityNumOfConcurrentIosPerDevice": 1, "vtreeMigrationIoPriorityPolicy": "favorAppIos", "vtreeMigrationIoPriorityQuietPeriodInMsec": null, "zeroPaddingEnabled": true}]

id

string

ID of the storage pool under protection domain.

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

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

statistics

dictionary

Statistics details of the storage pool.

Returned: success

capacityInUseInKb

string

Total capacity of the storage pool.

Returned: success

deviceIds

list / elements=string

Device Ids of the storage pool.

Returned: success

unusedCapacityInKb

string

Unused capacity of the storage pool.

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

Volumes

list / elements=string

Details of volumes.

Returned: always

Sample: [{"accessModeLimit": "ReadWrite", "ancestorVolumeId": null, "autoSnapshotGroupId": null, "compressionMethod": "Invalid", "consistencyGroupId": null, "creationTime": 1661234220, "dataLayout": "MediumGranularity", "id": "456afd7XXXXXXX", "lockedAutoSnapshot": false, "lockedAutoSnapshotMarkedForRemoval": false, "managedBy": "ScaleIO", "mappedSdcInfo": [{"accessMode": "ReadWrite", "isDirectBufferMapping": false, "limitBwInMbps": 0, "limitIops": 0, "sdcId": "c42425cbXXXXX", "sdcIp": "10.XXX.XX.XX", "sdcName": null}], "name": "vol-1", "notGenuineSnapshot": false, "originalExpiryTime": 0, "pairIds": null, "replicationJournalVolume": false, "replicationTimeStamp": 0, "retentionLevels": [], "secureSnapshotExpTime": 0, "sizeInKb": 8388608, "snplIdOfAutoSnapshot": null, "snplIdOfSourceVolume": null, "statistics": {"childVolumeIds": [], "descendantVolumeIds": [], "initiatorSdcId": null, "mappedSdcIds": ["c42425XXXXXX"], "numOfChildVolumes": 0, "numOfDescendantVolumes": 0, "numOfMappedSdcs": 1, "registrationKey": null, "registrationKeys": [], "replicationJournalVolume": false, "replicationState": "UnmarkedForReplication", "reservationType": "NotReserved", "rplTotalJournalCap": 0, "rplUsedJournalCap": 0, "userDataReadBwc": {"numOccured": 0, "numSeconds": 0, "totalWeightInKb": 0}, "userDataSdcReadLatency": {"numOccured": 0, "numSeconds": 0, "totalWeightInKb": 0}, "userDataSdcTrimLatency": {"numOccured": 0, "numSeconds": 0, "totalWeightInKb": 0}, "userDataSdcWriteLatency": {"numOccured": 0, "numSeconds": 0, "totalWeightInKb": 0}, "userDataTrimBwc": {"numOccured": 0, "numSeconds": 0, "totalWeightInKb": 0}, "userDataWriteBwc": {"numOccured": 0, "numSeconds": 0, "totalWeightInKb": 0}}, "storagePoolId": "7630a248XXXXXXX", "timeStampIsAccurate": false, "useRmcache": false, "volumeReplicationState": "UnmarkedForReplication", "volumeType": "ThinProvisioned", "vtreeId": "32b168bXXXXXX"}]

id

string

The ID of the volume.

Returned: success

mappedSdcInfo

dictionary

The details of the mapped SDC.

Returned: success

accessMode

string

mapping access mode for the specified volume.

Returned: success

limitBwInMbps

integer

Bandwidth limit for the SDC.

Returned: success

limitIops

integer

IOPS limit for the SDC.

Returned: success

sdcId

string

ID of the SDC.

Returned: success

sdcIp

string

IP of the SDC.

Returned: success

sdcName

string

Name of the SDC.

Returned: success

name

string

Name of the volume.

Returned: success

protectionDomainId

string

ID of the protection domain in which volume resides.

Returned: success

protectionDomainName

string

Name of the protection domain in which volume resides.

Returned: success

sizeInGb

integer

Size of the volume in Gb.

Returned: success

sizeInKb

integer

Size of the volume in Kb.

Returned: success

snapshotPolicyId

string

ID of the snapshot policy associated with volume.

Returned: success

snapshotPolicyName

string

Name of the snapshot policy associated with volume.

Returned: success

snapshotsList

string

List of snapshots associated with the volume.

Returned: success

statistics

dictionary

Statistics details of the storage pool.

Returned: success

numOfChildVolumes

integer

Number of child volumes.

Returned: success

numOfMappedSdcs

integer

Number of mapped Sdcs of the volume.

Returned: success

storagePoolId

string

ID of the storage pool in which volume resides.

Returned: success

storagePoolName

string

Name of the storage pool in which volume resides.

Returned: success

Authors

  • Arindam Datta (@dattaarindam)

  • Trisha Datta (@trisha-dell)

  • Jennifer John (@Jennifer-John)

  • Felix Stephen (@felixs88)