Update
PUT v1/groups/id
Description
Modify attributes of the group.
Normal Response Codes
200
HTTP Error Codes
400 401 403 404 409 500 503
Request
| Parameter | Type | JSON Type | Description | Mandatory | Deprecated |
|---|---|---|---|---|---|
| id | NsObjectID | string | Identifier of the group. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'. | true | |
| name | NsObjectName | string | Name of the group. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'. | false | |
| smtp_server | NsFqdn | string | Hostname or IP Address of SMTP Server. String of alphanumeric characters, valid range is from 2 to 255; Each label must be between 1 and 63 characters long; - and . are allowed after the first and before the last character. Example: 'example-1.com'. | false | |
| smtp_port | NsPort | number | Port number of SMTP Server. Positive integer value up to 65535 representing TCP/IP port. Example: 1234. | false | |
| smtp_auth_enabled | NsBoolean | boolean | Whether SMTP Server requires authentication. Possible values: 'true', 'false'. | false | |
| smtp_auth_username | NsUserName | string | Username to authenticate with SMTP Server. String of up to 80 alphanumeric characters, beginning with a letter. For Active Directory users, it can include backslash (\), dash (-), period (.), underscore (_) and space. Example: 'user1', 'companydomain\user1'. | false | |
| smtp_auth_password | NsPassword | string | Password to authenticate with SMTP Server. String of 8 to 255 printable characters excluding ampersand and ;[]`. Example: 'password-91'. | false | |
| smtp_encrypt_type | NsSmtpEncryptType | string enum | Level of encryption for SMTP. Requires use of SMTP Authentication if encryption is enabled. Possible values: 'none', 'starttls', 'ssl'. | false | |
| autosupport_enabled | NsBoolean | boolean | Whether to send autosupport. Possible values: 'true', 'false'. | false | |
| allow_support_tunnel | NsBoolean | boolean | Whether to allow support tunnel. Possible values: 'true', 'false'. | false | |
| proxy_server | NsProxyServer | string | Hostname or IP Address of HTTP Proxy Server. Setting this attribute to an empty string will unset all proxy settings. String of alphanumeric characters, can be an empty string, or valid range must be from 2 to 255; Each label must be between 1 and 63 characters long; - and . are allowed after the first and before the last character. Example: 'example-1.com'. | false | |
| proxy_port | NsProxyPort | number | Proxy Port of HTTP Proxy Server. Integer value between 0-65535 representing TCP/IP port. Example: 1234. | false | |
| proxy_username | NsProxyUserName | string | Username to authenticate with HTTP Proxy Server. HTTP proxy server username, string up to 255 characters, special characters ([, ], `, ;, ampersand, tab, space, newline) are not allowed. | false | |
| proxy_password | NsProxyPassword | string | Password to authenticate with HTTP Proxy Server. HTTP proxy server password, string up to 255 characters, special characters ([, ], `, ;, ampersand, tab, space, newline) are not allowed. | false | |
| alert_to_email_addrs | NsEmailList | string | Comma-separated list of email addresss to receive emails. Comma separated email list. Example: bob@wikipedia.com,jason@wiki.com. | false | |
| send_alert_to_support | NsBoolean | boolean | Whether to send alert to Support. Possible values: 'true', 'false'. | false | |
| alert_from_email_addr | NsEmail | string | From email address to use while sending emails. Case insensitive email address. Example: bob@wikipedia.com. | false | |
| alert_min_level | NsSeverityLevel | string enum | Minimum level of alert to be notified. Possible values: 'info', 'notice', 'warning', 'critical'. | false | |
| isns_enabled | NsBoolean | boolean | Whether iSNS is enabled. Possible values: 'true', 'false'. | false | |
| isns_server | NsFqdn | string | Hostname or IP Address of iSNS Server. String of alphanumeric characters, valid range is from 2 to 255; Each label must be between 1 and 63 characters long; - and . are allowed after the first and before the last character. Example: 'example-1.com'. | false | |
| isns_port | NsPort | number | Port number for iSNS Server. Positive integer value up to 65535 representing TCP/IP port. Example: 1234. | false | |
| snmp_trap_enabled | NsBoolean | boolean | Whether to enable SNMP traps. Possible values: 'true', 'false'. | false | |
| snmp_trap_host | NsFqdn | string | Hostname or IP Address to send SNMP traps. String of alphanumeric characters, valid range is from 2 to 255; Each label must be between 1 and 63 characters long; - and . are allowed after the first and before the last character. Example: 'example-1.com'. | false | |
| snmp_trap_port | NsPort | number | Port number of SNMP trap host. Positive integer value up to 65535 representing TCP/IP port. Example: 1234. | false | |
| snmp_get_enabled | NsBoolean | boolean | Whether to accept SNMP get commands. Possible values: 'true', 'false'. | false | |
| snmp_community | NsObjectName | string | Community string to be used with SNMP. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'. | false | |
| snmp_get_port | NsPort | number | Port number to which SNMP get requests should be sent. Positive integer value up to 65535 representing TCP/IP port. Example: 1234. | false | |
| snmp_sys_contact | NsString | string | Name of the SNMP administrator. Plain string. | false | |
| snmp_sys_location | NsString | string | Location of the group. Plain string. | false | |
| domain_name | NsFqdn | string | Domain name for this group. String of alphanumeric characters, valid range is from 2 to 255; Each label must be between 1 and 63 characters long; - and . are allowed after the first and before the last character. Example: 'example-1.com'. | false | |
| dns_servers | NsIPAddressList | Array of NsIPAddressObject | IP addresses for this group's dns servers. List of IP Addresses. | false | |
| ntp_server | NsString | string | Either IP address or hostname of the NTP server for this group. Plain string. | false | |
| timezone | NsString | string | Timezone in which this group is located. Plain string. | false | |
| user_inactivity_timeout | NsInactivityTimeout | number | The amount of time in seconds that the user session is inactive before timing out. User inactivity timeout in second, valid range is from 1 to 43200 (720 minutes). | false | |
| syslogd_enabled | NsBoolean | boolean | Is syslogd enabled on this system. Possible values: 'true', 'false'. | false | |
| syslogd_server | NsFqdn | string | Hostname of the syslogd server. String of alphanumeric characters, valid range is from 2 to 255; Each label must be between 1 and 63 characters long; - and . are allowed after the first and before the last character. Example: 'example-1.com'. | false | |
| syslogd_port | NsPort | number | Port number for syslogd server. Positive integer value up to 65535 representing TCP/IP port. Example: 1234. | false | |
| vvol_enabled | NsBoolean | boolean | Are vvols enabled on this group. Possible values: 'true', 'false'. | false | |
| iscsi_enabled | NsBoolean | boolean | Whether iSCSI is enabled on this group. Possible values: 'true', 'false'. | false | |
| fc_enabled | NsBoolean | boolean | Whether FC is enabled on this group. Possible values: 'true', 'false'. | false | |
| group_target_enabled | NsBoolean | boolean | Is group_target enabled on this group. Possible values: 'true', 'false'. | false | |
| default_volume_reserve | NsPercent | number | Amount of space to reserve for a volume as a percentage of volume size. Percentage as integer from 0 to 100. | false | |
| default_volume_warn_level | NsPercent | number | Default threshold for volume space usage as a percentage of volume size above which an alert is raised. Percentage as integer from 0 to 100. | false | |
| default_volume_limit | NsPercent | number | Default limit for a volume space usage as a percentage of volume size. Volume will be taken offline/made non-writable on exceeding its limit. Percentage as integer from 0 to 100. | false | |
| default_snap_reserve | NsUnsignedLong | number | Amount of space to reserve for snapshots of a volume as a percentage of volume size. Unsigned 64-bit integer. Example: 1234. | false | |
| default_snap_warn_level | NsUnsignedLong | number | Default threshold for snapshot space usage of a volume as a percentage of volume size above which an alert is raised. Unsigned 64-bit integer. Example: 1234. | false | |
| default_snap_limit | NsUnsignedLong | number | Default limit for a volume's snapshot space usage, expressed either as a percentage of the volume's size or as the largest possible signed 64-bit integer (9223372036854775807) to indicate that there is no limit. A volume will be taken offline or made non-writable upon exceeding its snapshot limit. This attribute is superseded by default_snap_limit_percent. Unsigned 64-bit integer. Example: 1234. | false | Yes |
| default_snap_limit_percent | NsSignedLong | number | Default limit for a volume's snapshot space usage, expressed either as a percentage of the volume's size or as -1 to indicate that there is no limit. A volume will be taken offline or made non-writable upon exceeding its snapshot limit. Signed 64-bit integer. Example: -1234. | false | |
| alarms_enabled | NsBoolean | boolean | Whether alarm feature is enabled. Possible values: 'true', 'false'. | false | |
| vss_validation_timeout | NsVssValidationTimeout | number | The amount of time in seconds to validate Microsoft VSS application synchronization before timing out. VSS validation timeout in second, valid range is from 1 to 3600 (60 minutes). | false | |
| repl_throttle_list | NsThrottles | Array of NsThrottle | All the replication bandwidth limits on the system. All the throttles for the partner. | false | |
| encryption_config | NsEncryptionSettings | object | How encryption is configured for this group. Group encryption settings. | false | |
| date | NsTime | number | Unix epoch time local to the group. Seconds since last epoch i.e. 00:00 January 1, 1970. Example: '3400'. | false | |
| login_banner_message | NsBanner | string | The message for the login banner that is displayed during user login activity. String upto 2048 characters. | false | |
| login_banner_after_auth | NsBoolean | boolean | Should the banner be displayed before the user credentials are prompted or after prompting the user credentials. Possible values: 'true', 'false'. | false | |
| login_banner_reset | NsBoolean | boolean | This will reset the banner to the version of the installed NOS. When login_banner_after_auth is specified, login_banner_reset can not be set to true. Possible values: 'true', 'false'. | false |
JSON Request
{
"data":{
"repl_throttle_list":[
{"name":"name-two",
"description":"desc-two",
"days":"sunday,wednesday,friday",
"thr_at_time":10801,
"thr_until_time":14400,
"thr_bandwidth":19
"thr_bandwidth_kbps":19000,
"thr_bandwidth_limit_kbps":19000
},
]
}
}
Response
| Parameter | Type | JSON Type | Description | Deprecated |
|---|---|---|---|---|
| id | NsObjectID | string | Identifier of the group. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'. | |
| name | NsObjectName | string | Name of the group. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'. | |
| smtp_server | NsFqdn | string | Hostname or IP Address of SMTP Server. String of alphanumeric characters, valid range is from 2 to 255; Each label must be between 1 and 63 characters long; - and . are allowed after the first and before the last character. Example: 'example-1.com'. | |
| smtp_port | NsPort | number | Port number of SMTP Server. Positive integer value up to 65535 representing TCP/IP port. Example: 1234. | |
| smtp_auth_enabled | NsBoolean | boolean | Whether SMTP Server requires authentication. Possible values: 'true', 'false'. | |
| smtp_auth_username | NsUserName | string | Username to authenticate with SMTP Server. String of up to 80 alphanumeric characters, beginning with a letter. For Active Directory users, it can include backslash (\), dash (-), period (.), underscore (_) and space. Example: 'user1', 'companydomain\user1'. | |
| smtp_encrypt_type | NsSmtpEncryptType | string enum | Level of encryption for SMTP. Requires use of SMTP Authentication if encryption is enabled. Possible values: 'none', 'starttls', 'ssl'. | |
| autosupport_enabled | NsBoolean | boolean | Whether to send autosupport. Possible values: 'true', 'false'. | |
| allow_support_tunnel | NsBoolean | boolean | Whether to allow support tunnel. Possible values: 'true', 'false'. | |
| proxy_server | NsProxyServer | string | Hostname or IP Address of HTTP Proxy Server. Setting this attribute to an empty string will unset all proxy settings. String of alphanumeric characters, can be an empty string, or valid range must be from 2 to 255; Each label must be between 1 and 63 characters long; - and . are allowed after the first and before the last character. Example: 'example-1.com'. | |
| proxy_port | NsProxyPort | number | Proxy Port of HTTP Proxy Server. Integer value between 0-65535 representing TCP/IP port. Example: 1234. | |
| proxy_username | NsProxyUserName | string | Username to authenticate with HTTP Proxy Server. HTTP proxy server username, string up to 255 characters, special characters ([, ], `, ;, ampersand, tab, space, newline) are not allowed. | |
| alert_to_email_addrs | NsEmailList | string | Comma-separated list of email addresss to receive emails. Comma separated email list. Example: bob@wikipedia.com,jason@wiki.com. | |
| send_alert_to_support | NsBoolean | boolean | Whether to send alert to Support. Possible values: 'true', 'false'. | |
| alert_from_email_addr | NsEmail | string | From email address to use while sending emails. Case insensitive email address. Example: bob@wikipedia.com. | |
| alert_min_level | NsSeverityLevel | string enum | Minimum level of alert to be notified. Possible values: 'info', 'notice', 'warning', 'critical'. | |
| isns_enabled | NsBoolean | boolean | Whether iSNS is enabled. Possible values: 'true', 'false'. | |
| isns_server | NsFqdn | string | Hostname or IP Address of iSNS Server. String of alphanumeric characters, valid range is from 2 to 255; Each label must be between 1 and 63 characters long; - and . are allowed after the first and before the last character. Example: 'example-1.com'. | |
| isns_port | NsPort | number | Port number for iSNS Server. Positive integer value up to 65535 representing TCP/IP port. Example: 1234. | |
| snmp_trap_enabled | NsBoolean | boolean | Whether to enable SNMP traps. Possible values: 'true', 'false'. | |
| snmp_trap_host | NsFqdn | string | Hostname or IP Address to send SNMP traps. String of alphanumeric characters, valid range is from 2 to 255; Each label must be between 1 and 63 characters long; - and . are allowed after the first and before the last character. Example: 'example-1.com'. | |
| snmp_trap_port | NsPort | number | Port number of SNMP trap host. Positive integer value up to 65535 representing TCP/IP port. Example: 1234. | |
| snmp_get_enabled | NsBoolean | boolean | Whether to accept SNMP get commands. Possible values: 'true', 'false'. | |
| snmp_community | NsObjectName | string | Community string to be used with SNMP. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'. | |
| snmp_get_port | NsPort | number | Port number to which SNMP get requests should be sent. Positive integer value up to 65535 representing TCP/IP port. Example: 1234. | |
| snmp_sys_contact | NsString | string | Name of the SNMP administrator. Plain string. | |
| snmp_sys_location | NsString | string | Location of the group. Plain string. | |
| domain_name | NsFqdn | string | Domain name for this group. String of alphanumeric characters, valid range is from 2 to 255; Each label must be between 1 and 63 characters long; - and . are allowed after the first and before the last character. Example: 'example-1.com'. | |
| dns_servers | NsIPAddressList | Array of NsIPAddressObject | IP addresses for this group's dns servers. List of IP Addresses. | |
| ntp_server | NsString | string | Either IP address or hostname of the NTP server for this group. Plain string. | |
| timezone | NsString | string | Timezone in which this group is located. Plain string. | |
| user_inactivity_timeout | NsInactivityTimeout | number | The amount of time in seconds that the user session is inactive before timing out. User inactivity timeout in second, valid range is from 1 to 43200 (720 minutes). | |
| syslogd_enabled | NsBoolean | boolean | Is syslogd enabled on this system. Possible values: 'true', 'false'. | |
| syslogd_server | NsFqdn | string | Hostname of the syslogd server. String of alphanumeric characters, valid range is from 2 to 255; Each label must be between 1 and 63 characters long; - and . are allowed after the first and before the last character. Example: 'example-1.com'. | |
| syslogd_port | NsPort | number | Port number for syslogd server. Positive integer value up to 65535 representing TCP/IP port. Example: 1234. | |
| vvol_enabled | NsBoolean | boolean | Are vvols enabled on this group. Possible values: 'true', 'false'. | |
| iscsi_enabled | NsBoolean | boolean | Whether iSCSI is enabled on this group. Possible values: 'true', 'false'. | |
| fc_enabled | NsBoolean | boolean | Whether FC is enabled on this group. Possible values: 'true', 'false'. | |
| access_protocol_list | NsAccessProtocolList | Array of NsAccessProtocol | Protocol used to access this group. List of access protocols. | |
| group_target_enabled | NsBoolean | boolean | Is group_target enabled on this group. Possible values: 'true', 'false'. | |
| group_target_name | NsString | string | Iscsi target name for this group. Plain string. | |
| default_volume_reserve | NsPercent | number | Amount of space to reserve for a volume as a percentage of volume size. Percentage as integer from 0 to 100. | |
| default_volume_warn_level | NsPercent | number | Default threshold for volume space usage as a percentage of volume size above which an alert is raised. Percentage as integer from 0 to 100. | |
| default_volume_limit | NsPercent | number | Default limit for a volume space usage as a percentage of volume size. Volume will be taken offline/made non-writable on exceeding its limit. Percentage as integer from 0 to 100. | |
| default_snap_reserve | NsUnsignedLong | number | Amount of space to reserve for snapshots of a volume as a percentage of volume size. Unsigned 64-bit integer. Example: 1234. | |
| default_snap_warn_level | NsUnsignedLong | number | Default threshold for snapshot space usage of a volume as a percentage of volume size above which an alert is raised. Unsigned 64-bit integer. Example: 1234. | |
| default_snap_limit | NsUnsignedLong | number | Default limit for a volume's snapshot space usage, expressed either as a percentage of the volume's size or as the largest possible signed 64-bit integer (9223372036854775807) to indicate that there is no limit. A volume will be taken offline or made non-writable upon exceeding its snapshot limit. This attribute is superseded by default_snap_limit_percent. Unsigned 64-bit integer. Example: 1234. | Yes |
| default_snap_limit_percent | NsSignedLong | number | Default limit for a volume's snapshot space usage, expressed either as a percentage of the volume's size or as -1 to indicate that there is no limit. A volume will be taken offline or made non-writable upon exceeding its snapshot limit. Signed 64-bit integer. Example: -1234. | |
| alarms_enabled | NsBoolean | boolean | Whether alarm feature is enabled. Possible values: 'true', 'false'. | |
| vss_validation_timeout | NsVssValidationTimeout | number | The amount of time in seconds to validate Microsoft VSS application synchronization before timing out. VSS validation timeout in second, valid range is from 1 to 3600 (60 minutes). | |
| merge_state | NsMergeState | string enum | State of group merge. Possible values: 'none', 'dest_start', 'dest_DB', 'dest_DB_done', 'dest_reassigned', 'dest_relinquish', 'dest_DB_failed', 'src_start', 'src_quiesced', 'src_reassigned', 'src_quiesce_failed', 'src_reassign_failed'. | |
| merge_group_name | NsString | string | Group that we're being merged with. Plain string. | |
| member_list | NsObjectNameList | Array of NsObjectName | Members of this group. A list of object names. | |
| compressed_vol_usage_bytes | NsBytes | number | Compressed usage of volumes in the group. Unsigned 64-bit integer. Example: '1234'. | |
| compressed_snap_usage_bytes | NsBytes | number | Compressed usage of snapshots in the group. Unsigned 64-bit integer. Example: '1234'. | |
| uncompressed_vol_usage_bytes | NsBytes | number | Uncompressed usage of volumes in the group. Unsigned 64-bit integer. Example: '1234'. | |
| uncompressed_snap_usage_bytes | NsBytes | number | Uncompressed usage of snapshots in the group. Unsigned 64-bit integer. Example: '1234'. | |
| usable_capacity_bytes | NsBytes | number | Usable capacity bytes of the group. Unsigned 64-bit integer. Example: '1234'. | |
| usage | NsBytes | number | Used space of the group in bytes. Unsigned 64-bit integer. Example: '1234'. | |
| raw_capacity | NsUnsignedLong | number | Total capacity of the group. Unsigned 64-bit integer. Example: 1234. | |
| usable_cache_capacity | NsUnsignedLong | number | Usable cache capacity of the group. Unsigned 64-bit integer. Example: 1234. | |
| raw_cache_capacity | NsUnsignedLong | number | Total cache capacity of the group. Unsigned 64-bit integer. Example: 1234. | |
| snap_usage_populated | NsUnsignedLong | number | Total snapshot usage as if each snapshot is deep copy of the volume. Unsigned 64-bit integer. Example: 1234. | |
| pending_deletes | NsUnsignedLong | number | Usage for blocks that are not yet deleted. Unsigned 64-bit integer. Example: 1234. | |
| num_connections | NsUnsignedLong | number | Number of connections to the group. Unsigned 64-bit integer. Example: 1234. | |
| vol_compression_ratio | NsRatio | number | Compression ratio of volumes in the group. Fraction expressed as floating point number. Example: '9.18'. | |
| snap_compression_ratio | NsRatio | number | Compression ratio of snapshots in the group. Fraction expressed as floating point number. Example: '9.18'. | |
| compression_ratio | NsRatio | number | Compression savings for the group expressed as ratio. Fraction expressed as floating point number. Example: '9.18'. | |
| dedupe_ratio | NsRatio | number | Dedupe savings for the group expressed as ratio. Fraction expressed as floating point number. Example: '9.18'. | |
| clone_ratio | NsRatio | number | Clone savings for the group expressed as ratio. Fraction expressed as floating point number. Example: '9.18'. | |
| vol_thin_provisioning_ratio | NsRatio | number | Thin provisioning savings for volumes in the group expressed as ratio. Fraction expressed as floating point number. Example: '9.18'. | |
| savings_ratio | NsRatio | number | Overall savings in the group expressed as ratio. Fraction expressed as floating point number. Example: '9.18'. | |
| data_reduction_ratio | NsRatio | number | Space savings in the group that does not include thin-provisioning savings expressed as ratio. Fraction expressed as floating point number. Example: '9.18'. | |
| savings_dedupe | NsBytes | number | Space usage savings in the group due to deduplication. Unsigned 64-bit integer. Example: '1234'. | |
| savings_compression | NsBytes | number | Space usage savings in the group due to compression. Unsigned 64-bit integer. Example: '1234'. | |
| savings_clone | NsBytes | number | Space usage savings in the group due to cloning of volumes. Unsigned 64-bit integer. Example: '1234'. | |
| savings_vol_thin_provisioning | NsBytes | number | Space usage savings in the group due to thin provisioning of volumes. Unsigned 64-bit integer. Example: '1234'. | |
| savings_data_reduction | NsBytes | number | Space usage savings in the group that does not include thin-provisioning savings. Unsigned 64-bit integer. Example: '1234'. | |
| savings | NsBytes | number | Overall space usage savings in the group. Unsigned 64-bit integer. Example: '1234'. | |
| free_space | NsBytes | number | Free space of the pool in bytes. Unsigned 64-bit integer. Example: '1234'. | |
| unused_reserve_bytes | NsBytes | number | Reserved space that is not utilized. Unsigned 64-bit integer. Example: '1234'. | |
| usage_valid | NsBoolean | boolean | Indicates whether the usage of group is valid. Possible values: 'true', 'false'. | |
| space_info_valid | NsBoolean | boolean | Is space info for this group valid. Possible values: 'true', 'false'. | |
| version_current | NsVersion | string | Version of software running on the group. String of up to 8 alphanumeric characters starting with v. Example: 'v1'. | |
| version_target | NsVersion | string | Desired software version for the group. String of up to 8 alphanumeric characters starting with v. Example: 'v1'. | |
| version_rollback | NsVersion | string | Rollback software version for the group. String of up to 8 alphanumeric characters starting with v. Example: 'v1'. | |
| update_state | NsUpdateState | string enum | Group update state. Possible values: 'invalid', 'normal', 'updating', 'timed_out', 'failed', 'paused'. | |
| update_start_time | NsTime | number | Start time of last update. Seconds since last epoch i.e. 00:00 January 1, 1970. Example: '3400'. | |
| update_end_time | NsTime | number | End time of last update. Seconds since last epoch i.e. 00:00 January 1, 1970. Example: '3400'. | |
| update_array_names | NsCommaSeparatedList | string | Arrays in the group undergoing update. Comma separated list of up to 64 non-empty lowercase alphanumeric strings without spaces. Example: 'name,app_id'. | |
| update_progress_msg | NsString | string | Group update detailed progress message. Plain string. | |
| update_error_code | NsErrorCode | string | If the software update has failed, this indicates the error code corresponding to the failure. Non-negative integer in range [0,9000]. | |
| update_downloading | NsBoolean | boolean | Is software update package currently downloading. Possible values: 'true', 'false'. | |
| update_download_error_code | NsErrorCode | string | If the software download has failed, this indicates the error code corresponding to the failure. Non-negative integer in range [0,9000]. | |
| update_download_start_time | NsTime | number | Start time of last update. Seconds since last epoch i.e. 00:00 January 1, 1970. Example: '3400'. | |
| update_download_end_time | NsTime | number | End time of last update. Seconds since last epoch i.e. 00:00 January 1, 1970. Example: '3400'. | |
| iscsi_automatic_connection_method | NsBoolean | boolean | Is iscsi reconnection automatic. Possible values: 'true', 'false'. | |
| iscsi_connection_rebalancing | NsBoolean | boolean | Does iscsi automatically rebalance connections. Possible values: 'true', 'false'. | |
| repl_throttled_bandwidth | NsSignedLong | number | Current bandwidth throttle for replication, expressed either as megabits per second or as -1 to indicate that there is no throttle. Signed 64-bit integer. Example: -1234. | |
| repl_throttled_bandwidth_kbps | NsSignedLong | number | Current bandwidth throttle for replication, expressed either as kilobits per second or as -1 to indicate that there is no throttle. Signed 64-bit integer. Example: -1234. | |
| repl_throttle_list | NsThrottles | Array of NsThrottle | All the replication bandwidth limits on the system. All the throttles for the partner. | |
| volume_migration_status | NsVolFamMigStatusList | Array of NsVolFamMigStatus | Status of data migration activity related to volumes being relocated to different pools. List of data migration status for a group of related volumes. | |
| array_unassign_migration_status | NsArrayUnassignMigStatusList | Array of NsArrayUnassignMigStatus | Data migration status for arrays being removed from their pool. Data migration status information for arrays being unassigned from their pool. | |
| data_rebalance_status | NsPoolRebalanceMigStatusList | Array of NsPoolRebalanceMigStatus | Status of data rebalancing operations for pools in the group. Status of data rebalancing operations for a list of pools. | |
| encryption_config | NsEncryptionSettings | object | How encryption is configured for this group. Group encryption settings. | |
| last_login | NsString | string | Time and user of last login to this group. Plain string. | |
| num_snaps | NsUnsignedLong | number | Number of snapshots in the group. Unsigned 64-bit integer. Example: 1234. | |
| num_snapcolls | NsUnsignedLong | number | Number of snapshot collections in this group. Unsigned 64-bit integer. Example: 1234. | |
| date | NsTime | number | Unix epoch time local to the group. Seconds since last epoch i.e. 00:00 January 1, 1970. Example: '3400'. | |
| login_banner_message | NsBanner | string | The message for the login banner that is displayed during user login activity. String upto 2048 characters. | |
| login_banner_after_auth | NsBoolean | boolean | Should the banner be displayed before the user credentials are prompted or after prompting the user credentials. Possible values: 'true', 'false'. | |
| login_banner_reset | NsBoolean | boolean | This will reset the banner to the version of the installed NOS. When login_banner_after_auth is specified, login_banner_reset can not be set to true. Possible values: 'true', 'false'. | |
| snap_retn_meter_high | NsUnsignedLong | number | Threshold for considering a volume as high retention. Unsigned 64-bit integer. Example: 1234. | Yes |
| snap_retn_meter_very_high | NsUnsignedLong | number | Threshold for considering a volume as very high retention. Unsigned 64-bit integer. Example: 1234. | Yes |
JSON Response
{
"data":{
"id":"0000000000000004d3000000000000000000000001",
"name":"g1a1",i
"smtp_server":"",
"smtp_port":25,
"smtp_auth_enabled":false,
"smtp_auth_username":"",
"smtp_auth_password":"",
"smtp_encrypt_type":"none",
"autosupport_enabled":true,
"allow_support_tunnel":false,
"proxy_server":"",
"proxy_port":0,
"proxy_username":"",
"proxy_password":"",
"alert_to_email_addrs":"",
"send_alert_to_support":true,
"alert_from_email_addr":"",
"alert_min_level":"notice",
"isns_enabled":false,
"isns_server":"",
"isns_port":3205,
"snmp_trap_enabled":false,
"snmp_trap_host":"",
"snmp_trap_port":162,
"snmp_get_enabled":false,
"snmp_community":"public",
"snmp_get_port":161,
"snmp_sys_contact":"",
"snmp_sys_location":"",
"domain_name":"",
"dns_servers":[{"ip_addr":""}],
"ntp_server":"0.mycompany.pool.ntp.org",
"timezone":"America/Los_Angeles",
"user_inactivity_timeout":1800,
"encryption_config":{
"master_key_set":false,
"mode":"none",
"scope":"none",
"cipher":"none",
"encryption_active":false},
"syslogd_enabled":false,
"syslogd_server":"",
"syslogd_port":514,
"vvol_enabled":true,
"group_target_enabled":false,
"group_target_name":"iqn.2007-11.com.mycompany:g1a1-g00000000000004d3",
"default_volume_reserve":0,
"default_snap_reserve":0,
"default_volume_warn_level":80,
"default_volume_limit":100,
"default_snap_warn_level":0,
"default_snap_limit":9223372036854775807,
"default_snap_limit_percent": -1,
"compressed_vol_usage_bytes":0,
"compressed_snap_usage_bytes":0,
"uncompressed_vol_usage_bytes":0,
"uncompressed_snap_usage_bytes":0,
"vol_compression_ratio":1,
"snap_compression_ratio":1,
"compression_ratio":1,
"dedupe_ratio":1,
"clone_ratio":1,
"vol_thin_provisioning_ratio":1,
"savings_ratio":1,
"data_reduction_ratio":1,
"savings_dedupe":0,
"savings_compression":0,
"savings_clone":0,
"savings_vol_thin_provisioning":0,
"savings_data_reduction":0,
"savings":0,
"usable_capacity_bytes":3983343616,
"usage":0,
"free_space":3983343616,
"unused_reserve_bytes":0,
"usage_valid":true,
"member_list":["g1a1"],
"last_login":"admin @ 2016-04-27T17:30:40-0700",
"space_info_valid":true,
"raw_capacity":0,
"usable_cache_capacity":2145386496,
"raw_cache_capacity":0,
"snap_usage_populated":0,
"pending_deletes":0,
"version_current":"",
"version_target":"",
"version_rollback":"",
"update_state":"normal",
"update_start_time":-1,
"update_end_time":-1,
"update_array_names":"",
"update_progress_msg": "",
"update_error_code": "1000",
"update_downloading": "true",
"update_download_error_code": "1325",
"update_download_start_time": 1460477565,
"update_download_end_time": 1460477565,
"merge_state":"none",
"merge_group_name":"",
"repl_throttled_bandwidth":-1,
"repl_throttled_bandwidth_kbps":-1,
"repl_throttle_list":[
{"id":1,
"description":"desc-two",
"creation_time":1461803938,
"last_modified":1461803938,
"thr_day_mask":41,
"thr_bandwidth":19,
"thr_bandwidth_kbps":19000,
"thr_bandwidth_limit_kbps":19000,
"thr_at_time":10801,
"thr_until_time":14400
}
],
"iscsi_automatic_connection_method":true,
"iscsi_connection_rebalancing":true,
"alarm_list":["0"],
"num_snaps":0,
"num_snapcolls":0,
"access_protocol_list":["iscsi"],
"snap_retn_meter_high":0,
"snap_retn_meter_very_high":0,
"date":1461803939,
"volume_migration_status":[],
"array_unassign_migration_status":[],
"data_rebalance_status":[],
"alarms_enabled":true,
"vss_validation_timeout": 60
}
}