Resource definitions
RESTful API sends the settings of the specified resource in response to all submitted GET requests.
- Encryption groups
-
"data" { "encryption_groups": [ { "id" : "1", "link" : { "rel" : "self", "href" : "https://{hmc}/api/v1/ encryption_groups/1" }, "state" : "accessible" | "rekeying" | "inaccessible" | "unconfigured" } ] } - Events
-
"data" { "events": [ { "id" : "SE..." "type" : "PoolCapacityChanged" , "severity" : "error", "time" : "2014-04-20T13:00:23-0700", "resource_id" : "", "formatted_parameter" : [ ] } ] } - FlashCopy relationships
-
"data" { "flashcopies": [ { "id" : "0000:1000", "link" : { "rel" : "self", "href" : "https://{hmc}/api/v1/flashcopies/0000:1000" }, "source_volume": { "id":"0000", "link":{ rel="self", href="https://{hmc}/api/v1/volumes/0000"} }, "target_volume": { "id":"1000", "link":{ rel="self", href="https://{hmc}/api/v1/volumes/1000"} }, "out_of_sync_tracks" : "0", "state" : "invalid" | "valid" | "invalid" | "validation_required" | "volume_inaccessible" | "tgt_failed" } ] } - Hosts
-
"data" { "hosts": [ { "link" : { "rel" : "self", "href" : "https://{hmc}/api/v1/hosts/ test_host" }, "name" : "test_host", "state" : "online" | "offline", "hosttype" : "VMware", "addrmode" : "SCSI mask" | "SCSI map" | "OS/400 mask" | , "addrdiscovery" : "lunpolling" | "reportlun", "lbs" : "512" | "520", "ioports" : {"link" : { "rel" : "self", "href" : "https://{hmc}/ api/v1/hosts/test_host/ioports" }}, "host_ports" : { "link" : { "rel" : "self", "href" : "/https://{hmc}/ api/v1/hosts/test_host/host_ports" }}, "volumes" : { "link" : { "rel" : "self", "href" : "/https://{hmc}/ api/v1/hosts/test_host/volumes" }} } ] } - Host mappings
-
"data" { "mappings": [ { "link" : { "rel" : "self", "href" : "https://{hmc}/api/v1/ hosts/test_host/mappings/00" }, "lunid" : "00", "volume" : { "id" : "0005", "link" : { "rel" : "self", "href" : "/https://{hmc}/api/v1/ volumes/0005" } } } ] } - Host ports
-
"data" { "host_ports": [ { "link" : { "rel" : "self", "href" : "https://{hmc}/api/v1/ host_ports/50050763030813A2" }, "wwpn" : "50050763030813A2", "state" : "logged in" | "logged out" | "unconfigured", "hosttype" : "VMware", "addrdiscovery" : "lunpolling" | "reportlun", "lbs" : "512" | "520", "host": { "name" : "myhost", "link" : { "rel" : "self", "href" : "https://{hmc}/api/v1/ hosts/myhost" } } } ] } - I/O enclosures
-
"data" { "io_enclosures": [ { "id" : "1", "link" : { "rel" : "self", "href" : "https://{hmc}/api/v1/io_enclosures/1" }, "name" : "cpssebay01" "state" : "online" | "offline" | "fenced" | "quiescing" | "resuming" } ] } - I/O ports
-
"data" { "fc_ports": [ { "link" : { "rel" : "self", "href" : "https://{hmc}/api/v1/ ioports/I0030" }, "id" : "I0030", "state" : "online" | "offline" | "fenced" | "quiescing" | "resuming" | "deconfigured", "protocol" : "FICON" | "FC-AL" | "SCSI-FCP" | "SCSI-FCP/FICON", "wwpn" : "50050763030313A2", "type" : "ESCON" | "Fibre Channel-LW" | "Fibre Channel-SW" | "Fibre Channel-LW 4KM", "speed" : "8 Gb/s", "loc" : "U1400.1B1.RJ34736-P1-C4-T0" } ] } - LSSs
-
"data" { "lss": [ { "id" : "00", "type" : "fb" | "ckd", "group" : "0", "addrgrp" : "0","sub_system_identifier" : "FF10", "ckd_base_cu_type" : "3990-3" | "3990-tpf" | "3990-6" | "bs2000" "pprc_consistency_group" : "enable" | "disable", "critical_mode" : "enable" | "disable", "extended_long_busy_time" : "60", "cc_session_timeout" : "300", "xrc_session_timeout" : "300","configvols" : "16", "volumes" : { "link" : { "rel" : "self", "href" : "https://{hmc}/api/v1/ lss/00/volumes" } } } ] } - Managed arrays
-
"data" { "marrays": [ { "id" : "MA1" "link" : { "rel" : "self", "href" : "https://{hmc}/api/v1/ marrays/MA1" }, "disk_class" : "enterprise" | "nearline" | "reserved" | "sata" | "ssd" | "flash" | "unknown", "pool" : { "id" : P0, "link" : { "rel" : "self", "href" : "https://{hmc}/api/v1/ pools/P0" } } } ] } - ODD files (DS8880, only)
-
"data" { "odd": [ { "status" : "ongoing" | "failed" | "successful" } ] } - PE package (DS8880, only)
-
"data" { "pepackage": [ { "area" : "general" | "ui" | "ettraces" | "etlogs" | "panic" | "prolongedIO" , "status" : "ongoing" | "failed" | "partially_successful" | "successful" } ] } - Performance
-
"data" { "performance": [ { "name" : "NI5_2", "IOPS" : { "read": "54285.37", "write": "17371.14", "total": "71656.52" }, "responseTime" : { "read": "1", "write": "1.83", "average": "1.2" }, "performancesampletime": "2015-04-01T01:31:34-0700" }, … ] } - Pools
-
"data" { "pools": [ { "link" : { "rel" : "self", href : "https://{hmc}/api/v1/pools/P0" }, "id" : "P0", "name" : "mypool" "node" : "0", "stgtype" : "fb" | "ckd", "cap" : "634715635712", # bytes (FB) "capalloc" : "0", # bytes (FB) "capavail" : "634715635712", # bytes (FB) "overprovisioned" : "2.4", "easytier" : "managed" | "none" | "unknown" "extent_size" : "1GiB" | "1113cyl" | "16MiB" | "21cyl" | "" "tieralloc" : [ { "tier" : "ENT" , "cap" : "634715635712", "allocated" : "0", # bytes (FB) "assigned" : "0" } ] "threshold" : "80", "eserep" : { "link" : { "rel" : "self", "href" : "https://{hmc}/api/ v1/pools/P0/eserep" } }, "tserep" : {"link" : { "rel" : "self", "href" : "https://{hmc}/api/ v1/pools/P0/tserep" } }, "volumes" : {"link" : { "rel" : "self", "href" : "https://{hmc}/api/ v1/pools/P0/volumes"}} } ] } - Remote Mirror and Copy (formerly PPRC)
-
"data" { "pprcs": [ { "id" : "2107-1300861_0000:2107-75YZ881_1000", "source_volume": { "id":"0000", "link":{rel="self", href="https://{hmc}/api/v1/volumes/0000"} # link will be empty if this query is triggered on target }, "source_system": { "id" : "2107-75YZ881", "link":{rel="self", href="https://{hmc}/api/v1/systems/2107-75YZ881"} # same as above } "target_volume": { "id":"1000", "link":{} # link will be empty if this query is triggered on source }, "target_system" { "id" : "2107-75YZ881", "link" : {} # same as above }, "type" : "metro_mirror" | "globalcopy" | "unknown", "state" : "copy_pending" | "full_duplex" | "target_copy_pending" | "target_full_duplex" | "target_suspended" | "suspended" | "invalid" | "volume_inaccessible" | "validation_required" } ] } - Remote Mirror and Copy (formerly PPRC) paths
-
"data": { "paths": [ { "id": "5005076306FFD341_00:5005076306FFD341_00" , "link": { "rel": "self" , "href": "https:/r8gui1h.tuc.stglabs.ibm.com/api/v1/cs/ pprcs/paths/5005076306FFD341_00:5005076306FFD341_00" }, "source_lss_id": "00" , "target_lss_id": "00" , "target_system_wwnn": "5005076306FFD341", "pprc_consistency_group": "disabled" | "enabled", "port_pairs": [ { "source_port_id": "I0003", "target_port_id": "I0007", "state": "success" | "failed" | "invalid" } ] } ] } - Remote Mirror and Copy (formerly PPRC) physical link
-
"data": { "physical_links": [ { "source_port_id": "I0003", "target_port_id": "I0007" } ] } - Remote Mirror and Copy (formerly PPRC) volumes
-
"data" { "pprcs": [ { "id" : "2107-1300861_0000:2107-75YZ881_1000" , "source_volume" : { "id":"0000", "link": # link will be empty if this query is triggered on secondary { "rel"="self", "href"="https://{hmc}/api/v1/volumes/0000" } }, "source_volume": { "id":"1000", "link": # same as above { "rel"="self", "href"="https://{hmc}/api/v1/systems/2107-75YZ881" } } "target_volume": { "id":"1000", "link":{} # link will be empty if this query is triggered on primary }, "target_system" { "id":"2107-75YZ881", "link":{} # same as above }, "type" : "metromirror" | "globalcopy" | "unknown" "state" : "copy_pending" | "full_duplex" | "target_copy_pending" | "target_full_duplex" | "target_suspended" | "suspended" | "invalid" | "volume_inaccessible" | "validation_required" } ] } - Self upgrade
-
"data" { "upgrade": [ { "last_upgrade_time" : "2015-01-20T15:07:25-0700" "last_upgrade_status" : "successful" | "failed" , "last_upgrade_message" : "" } ] } - Space-efficient storage
-
"data" { "eserep | tserep": [ { "link" : { "rel" : "self", "href" : "https://{hmc}/api/v1/ pools/P0/tserep" }, "cap" : "16911433728", # bytes (FB) "capalloc" : "0", # bytes (FB) "capavail" : "16911433728", # bytes (FB) "overprovisioned" : "2.4", "threshold" : "85", pool : { "id" : P0, "link" : { "rel" : "self", "href" : "https://{hmc}/api/v1/ pools/P0" } } } ] } - Statesave files (DS8880, only)
-
"data" { "statesave": [ { "status" : "ongoing" | "failed" | "successful" } ] } - Systems
-
"data" { "systems": [ { "name" : "NI5_2", "state" : "online" | "fenced" | "forced_quiescing" | "offline" | "quiescing" | "quiesce_exception" | "resuming" | "discovery", "release" : "7.4", "bundle" : "87.50.34.0", "mtm" : "2421-961", "sn" : "75YZ881", "cap" : "105871", # bytes (FB) "capalloc" : "75005", # bytes (FB) "capavail" : "30866", # bytes (FB) "capraw" : "228420" # bytes (FB) } ] } - Users
-
"data" { "users": [ { "name" : "admin" "state" : "locked" | "active" , "group" : [ "Administrator", "SecurityAdministrator", "OperatorPhysicalConf", "OperatorLogicalConf”, "OperatorCopyServices”, "OperatorServiceFunctions”, "Monitor”, "Auditor”, "Default” ] } ] } - Volumes
-
"data" { "volumes" : [ { "link" : { "rel" : "self", "href" : "https://{hmc}/api/v1/ volumes/0000" }, "id" : "0000", "name" : "mytest", "state" : "pinned" | "readonly" | "inaccessible" | "indeterminate_data_loss" | "rank_failed" | "rank_repairing" | "rank_repaired" | "global_inaccessible" | "global_lost" | "virtual_space_fault" | "nvs_inaccessible" | "normal" | "configuring" | "reconfiguring" | "migrating" | "deconfiguring" | "config_error" | "reconfig_error" | "migration_error" | "deconfig_error" | "merging" | "migration_paused" | "migration_cancelled" | "transposition_error" | "unknown" "cap" : "322122547200", # bytes (FB) "cap_gb": "300", "cap_gib": "322.1", "real_cap": "322122547200", "virtual_cap": "0"; "stgtype" : "fb" | "ckd", "VOLSER" : "", "lss" : { "id" : "00", "link" : { "rel" : "self", "href" : "https://{hmc}/api/v1/lss/00" } }, "allocmethod" : "legacy" | "rotatevols" | "rotateexts" | "managed" | "", "tp" : "none", "capalloc" : "134217728", # bytes (FB) "MTM" : "2107-900", "datatype" : "FB 512" | "FB 512T" | "FB 520P" | "FB 520U" | "FB 520PV" | "FB 520UV" | "3380" | "3390" | "3390-A" | "", "easytier" : "managed" | "none" | "unknown" "tieralloc" : [ { "tier" : "ENT" , "allocated" : "34502" } ] "pool" : { "id" : "P2", "link" : { "rel" : "self", "href" : "https://{hmc}/api/v1/pools/P2" }} } ] }