HTTP command interface reference

With the HTTP command interface, you can run operations on your appliance, configure appliance settings, and administer data grids, collectives, and zones.

Table of contents

List of APPLIANCE commands
 
CreateAdminTrace
Description:  Adds or modifies an existing administrative trace string.
Required Parameters: 
stopOnTaskFailure   Specifies whether to stop running the batch routine when the task fails. If the value is set to true, the batch routine stops. If the value is false or blank, the batch routine does not stop. Applies to commands that are run in batch processes only.
traceName   Specifies the name of the trace.
Result Parameters: 
errorMessage   A message that explains the reason for the failure, if the command failed.
status   Specifies the status of the command that was run. The result can be either success or failed.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
commandName   Specifies the name of the HTTP command interface command that was run.
Example:  { "task": { "stopOnTaskFailure": "true", "traceName": "AutoCustomLogger", "command": "CreateAdminTrace" } }
Command Type:  appliance
 
 
CreateAggregateInterface
Description:  Creates a new Aggregate Interface.
Required Parameters: 
member   Lists all ethernet interface members of this aggregation.
stopOnTaskFailure   Specifies whether to stop running the batch routine when the task fails. If the value is set to true, the batch routine stops. If the value is false or blank, the batch routine does not stop. Applies to commands that are run in batch processes only.
primary_member   Specifies which of the aggregated ethernet interfaces is the primary one.
aggregation_policy   Specifies the aggregation policy of the interface.
address   Specifies IP address of the interface.
name   Specifies the interface name.
Result Parameters: 
errorMessage   A message that explains the reason for the failure, if the command failed.
status   Specifies the status of the command that was run. The result can be either success or failed.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
commandName   Specifies the name of the HTTP command interface command that was run.
Example:  { "task": { "member": "eth0,eth1", "stopOnTaskFailure": "true", "primary_member": "eth0", "aggregation_policy": "active-backup", "address": "1:2:3:4/24", "name": "agg1", "command": "CreateAggregateInterface" } }
Command Type:  appliance
 
 
CreateDataCacheTrace
Description:  Adds or modifies an existing data cache trace string.
Required Parameters: 
stopOnTaskFailure   Specifies whether to stop running the batch routine when the task fails. If the value is set to true, the batch routine stops. If the value is false or blank, the batch routine does not stop. Applies to commands that are run in batch processes only.
traceName   Specifies the name of the trace.
Result Parameters: 
errorMessage   A message that explains the reason for the failure, if the command failed.
status   Specifies the status of the command that was run. The result can be either success or failed.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
commandName   Specifies the name of the HTTP command interface command that was run.
Example:  { "task": { "stopOnTaskFailure": "true", "traceName": "autoDataCacheLogger", "command": "CreateDataCacheTrace" } }
Command Type:  appliance
 
 
CreateSNMPCommunity
Description:  Creates a Simple Network Management Protocol (SNMP) community.
Required Parameters: 
hostRestriction   (Optional) Specifies an IP address on which to restrict SNMP communication. Communication with any other IP address or subnet is denied.
stopOnTaskFailure   Specifies whether to stop running the batch routine when the task fails. If the value is set to true, the batch routine stops. If the value is false or blank, the batch routine does not stop. Applies to commands that are run in batch processes only.
communityName   Specifies the name of the SNMP community to create.
Result Parameters: 
errorMessage   A message that explains the reason for the failure, if the command failed.
status   Specifies the status of the command that was run. The result can be either success or failed.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
commandName   Specifies the name of the HTTP command interface command that was run.
Example:  { "task": { "hostRestriction": "autorestriction", "stopOnTaskFailure": "true", "command": "CreateSNMPCommunity", "communityName": "autocommunity" } }
Command Type:  appliance
 
 
DeleteSNMPCommunity
Description:  Deletes a Simple Network Management Protocol (SNMP) community.
Required Parameters: 
stopOnTaskFailure   Specifies whether to stop running the batch routine when the task fails. If the value is set to true, the batch routine stops. If the value is false or blank, the batch routine does not stop. Applies to commands that are run in batch processes only.
communityName   Specifies the name of SNMP community to delete.
Result Parameters: 
errorMessage   A message that explains the reason for the failure, if the command failed.
status   Specifies the status of the command that was run. The result can be either success or failed.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
commandName   Specifies the name of the HTTP command interface command that was run.
Example:  { "task": { "stopOnTaskFailure": "true", "command": "DeleteSNMPCommunity", "communityName": "autocommunity" } }
Command Type:  appliance
 
 
EnableCreateAccount
Description:  Enables a setting that allows users to initiate the creation of their own accounts.
Required Parameters: 
stopOnTaskFailure   Specifies whether to stop running the batch routine when the task fails. If the value is set to true, the batch routine stops. If the value is false or blank, the batch routine does not stop. Applies to commands that are run in batch processes only.
enable   Enables account creation. Set the value to false to disable account creation. Set the value to true to enable account creation.
Result Parameters: 
errorMessage   A message that explains the reason for the failure, if the command failed.
status   Specifies the status of the command that was run. The result can be either success or failed.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
commandName   Specifies the name of the HTTP command interface command that was run.
Example:  { "task": { "stopOnTaskFailure": "true", "enable": "true", "command": "EnableCreateAccount" } }
Command Type:  appliance
 
 
EnablePasswordReset
Description:  Enables the ability to reset the xcadmin password with a serial connection. No other credentials or SMTP messages are required.
Required Parameters: 
stopOnTaskFailure   Specifies whether to stop running the batch routine when the task fails. If the value is set to true, the batch routine stops. If the value is false or blank, the batch routine does not stop. Applies to commands that are run in batch processes only.
enable   Enables the password to be reset. Set the value to true to enable password resets.
Result Parameters: 
errorMessage   A message that explains the reason for the failure, if the command failed.
status   Specifies the status of the command that was run. The result can be either success or failed.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
commandName   Specifies the name of the HTTP command interface command that was run.
Example:  { "task": { "stopOnTaskFailure": "true", "enable": "true", "command": "EnablePasswordReset" } }
Command Type:  appliance
 
 
EnableSNMP
Description:  Enables or disables Simple Network Management Protocol (SNMP).
Required Parameters: 
stopOnTaskFailure   Specifies whether to stop running the batch routine when the task fails. If the value is set to true, the batch routine stops. If the value is false or blank, the batch routine does not stop. Applies to commands that are run in batch processes only.
enable   Enables SNMP. Set the value to false to disable SNMP. Set the value to true to enable SNMP.
Result Parameters: 
errorMessage   A message that explains the reason for the failure, if the command failed.
status   Specifies the status of the command that was run. The result can be either success or failed.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
commandName   Specifies the name of the HTTP command interface command that was run.
Example:  { "task": { "stopOnTaskFailure": "true", "enable": "true", "command": "EnableSNMP" } }
Command Type:  appliance
 
 
ModifyAdminDefaultTrace
Description:  Changes the trace level for the administrative default logger.
Required Parameters: 
stopOnTaskFailure   Specifies whether to stop running the batch routine when the task fails. If the value is set to true, the batch routine stops. If the value is false or blank, the batch routine does not stop. Applies to commands that are run in batch processes only.
traceLevel   Specifies the trace level. Valid values: OFF, SEVERE, WARNING, or INFO.
Result Parameters: 
errorMessage   A message that explains the reason for the failure, if the command failed.
status   Specifies the status of the command that was run. The result can be either success or failed.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
commandName   Specifies the name of the HTTP command interface command that was run.
Example:  { "task": { "stopOnTaskFailure": "true", "traceLevel": "SEVERE", "command": "ModifyAdminDefaultTrace" } }
Command Type:  appliance
 
 
ModifyAdminTrace
Description:  Changes an administrative logger trace level.
Required Parameters: 
stopOnTaskFailure   Specifies whether to stop running the batch routine when the task fails. If the value is set to true, the batch routine stops. If the value is false or blank, the batch routine does not stop. Applies to commands that are run in batch processes only.
traceLevel   Specifies the trace level. Valid values: OFF, SEVERE, WARNING, INFO, FINE, FINER, FINEST, ALL.
traceName   Specifies the name of the trace to modify.
Result Parameters: 
errorMessage   A message that explains the reason for the failure, if the command failed.
status   Specifies the status of the command that was run. The result can be either success or failed.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
commandName   Specifies the name of the HTTP command interface command that was run.
Example:  { "task": { "stopOnTaskFailure": "true", "traceLevel": "SEVERE", "traceName": "autoCustomLogger", "command": "ModifyAdminTrace" } }
Command Type:  appliance
 
 
ModifyAdministratorEmail
Description:  Changes the default administrator email address.
Required Parameters: 
stopOnTaskFailure   Specifies whether to stop running the batch routine when the task fails. If the value is set to true, the batch routine stops. If the value is false or blank, the batch routine does not stop. Applies to commands that are run in batch processes only.
administratorEmail   Specifies a new email address for the default administrator account.
Result Parameters: 
errorMessage   A message that explains the reason for the failure, if the command failed.
status   Specifies the status of the command that was run. The result can be either success or failed.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
commandName   Specifies the name of the HTTP command interface command that was run.
Example:  { "task": { "stopOnTaskFailure": "true", "administratorEmail": "somenewname@us.ibm.com", "command": "ModifyAdministratorEmail" } }
Command Type:  appliance
 
 
ModifyAdministratorName
Description:  Changes the default administrator account name.
Required Parameters: 
stopOnTaskFailure   Specifies whether to stop running the batch routine when the task fails. If the value is set to true, the batch routine stops. If the value is false or blank, the batch routine does not stop. Applies to commands that are run in batch processes only.
administratorName   Specifies the new name for the default administrator account.
Result Parameters: 
errorMessage   A message that explains the reason for the failure, if the command failed.
status   Specifies the status of the command that was run. The result can be either success or failed.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
commandName   Specifies the name of the HTTP command interface command that was run.
Example:  { "task": { "stopOnTaskFailure": "true", "administratorName": "somenewname", "command": "ModifyAdministratorName" } }
Command Type:  appliance
 
 
ModifyAdministratorPassword
Description:  Changes the password for the default administrator account.
Required Parameters: 
stopOnTaskFailure   Specifies whether to stop running the batch routine when the task fails. If the value is set to true, the batch routine stops. If the value is false or blank, the batch routine does not stop. Applies to commands that are run in batch processes only.
newPassword   Specifies a new default administrator account password.
passwordVerification   Specifies a new default administrator account password, entered a second time for verification.
Result Parameters: 
errorMessage   A message that explains the reason for the failure, if the command failed.
status   Specifies the status of the command that was run. The result can be either success or failed.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
commandName   Specifies the name of the HTTP command interface command that was run.
Example:  { "task": { "stopOnTaskFailure": "true", "newPassword": "somepass", "passwordVerification": "somepass", "command": "ModifyAdministratorPassword" } }
Command Type:  appliance
 
 
ModifyAggregateInterface
Description:  Modifies Aggregate Interface parameters.
Required Parameters: 
stopOnTaskFailure   Specifies whether to stop running the batch routine when the task fails. If the value is set to true, the batch routine stops. If the value is false or blank, the batch routine does not stop. Applies to commands that are run in batch processes only.
name   Specifies the interface name.
Result Parameters: 
errorMessage   A message that explains the reason for the failure, if the command failed.
status   Specifies the status of the command that was run. The result can be either success or failed.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
commandName   Specifies the name of the HTTP command interface command that was run.
Example:  { "task": { "mtu": "1500", "member": "eth0,eth1", "stopOnTaskFailure": "true", "transmit_hash_policy": "layer2", "dad_retransmit_timer": "1000", "use_slaac": "true", "mode": "Auto", "use_dhcp": "false", "use_arp": "true", "primary_member": "eth0", "aggregation_policy": "active-backup", "address": "1:2:3:4/24", "name": "agg1", "command": "ModifyAggregateInterface", "dad_transmits": "1", "lacp_selection_logic": "stable", "ipv4_default_gateway": "1:2:3:5" } }
Command Type:  appliance
 
 
ModifyDataCacheTrace
Description:  Adds or modifies an existing data cache trace string.
Required Parameters: 
stopOnTaskFailure   Specifies whether to stop running the batch routine when the task fails. If the value is set to true, the batch routine stops. If the value is false or blank, the batch routine does not stop. Applies to commands that are run in batch processes only.
traceLevel   Specifies the trace level. Valid values: OFF, SEVERE, WARNING, INFO, FINE, FINER, FINEST, ALL.
traceName   Specifies the name of the trace.
Result Parameters: 
errorMessage   A message that explains the reason for the failure, if the command failed.
status   Specifies the status of the command that was run. The result can be either success or failed.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
commandName   Specifies the name of the HTTP command interface command that was run.
Example:  { "task": { "stopOnTaskFailure": "true", "traceLevel": "SEVERE", "traceName": "autoDataCacheLogger", "command": "ModifyDataCacheTrace" } }
Command Type:  appliance
 
 
ModifyEthernetInterface
Description:  Modifies Ethernet Interface parameters.
Required Parameters: 
stopOnTaskFailure   Specifies whether to stop running the batch routine when the task fails. If the value is set to true, the batch routine stops. If the value is false or blank, the batch routine does not stop. Applies to commands that are run in batch processes only.
name   Specifies the interface name.
Result Parameters: 
errorMessage   A message that explains the reason for the failure, if the command failed.
status   Specifies the status of the command that was run. The result can be either success or failed.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
commandName   Specifies the name of the HTTP command interface command that was run.
Example:  { "task": { "mtu": "1500", "use_dhcp": "false", "use_arp": "true", "stopOnTaskFailure": "true", "dad_retransmit_timer": "1000", "use_slaac": "true", "address": "1:2:3:4/24", "name": "eth0", "dad_transmits": "1", "command": "ModifyEthernetInterface", "ipv4_default_gateway": "1:2:3:5", "mode": "Auto" } }
Command Type:  appliance
 
 
ModifyLDAP
Description:  Configures the appliance to use Lightweight Directory Access Protocol (LDAP) for user login authentication.
Required Parameters: 
jndiSecurityPrincipal   Specifies the JNDI security principal.
stopOnTaskFailure   Specifies whether to stop running the batch routine when the task fails. If the value is set to true, the batch routine stops. If the value is false or blank, the batch routine does not stop. Applies to commands that are run in batch processes only.
ldapUserIdSearchFilterPattern   LDAP user search filter pattern.
newPassword   Specifies the new LDAP password.
groupBaseDn   Specifies the LDAP JNDI base distinguished name (DN) for groups.
passwordVerification   Specifies the new LDAP password a second time for password verification. The value must be the same as the newPassword parameter.
userBaseDn   Specifies the LDAP JNDI base distinguished name (DN) for users.
enable   Specifies if LDAP user authentication is enabled. Set the value to true to enable LDAP user authentication.
jndiProviderURL   Specifies the URL for the LDAP provider.
Result Parameters: 
errorMessage   A message that explains the reason for the failure, if the command failed.
status   Specifies the status of the command that was run. The result can be either success or failed.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
commandName   Specifies the name of the HTTP command interface command that was run.
Example:  { "task": { "stopOnTaskFailure": "true", "jndiSecurityPrincipal": "CN=Administrator,CN=users,DC=mycompany,DC=com", "ldapUserIdSearchFilterPattern": "thefilterpattern", "newPassword": "somepassword", "passwordVerification": "somepassword", "groupBaseDn": "cn=group", "userBaseDn": "cn=user", "enable": "true", "command": "ModifyLDAP", "jndiProviderURL": "someurl" } }
Command Type:  appliance
 
 
ModifyNtpServers
Description:  Changes the list of Network Time Protocol (NTP) servers.
Required Parameters: 
stopOnTaskFailure   Specifies whether to stop running the batch routine when the task fails. If the value is set to true, the batch routine stops. If the value is false or blank, the batch routine does not stop. Applies to commands that are run in batch processes only.
listOfServers   Specifies a list of comma-separated Network Time Protocol (NTP) servers.
Result Parameters: 
errorMessage   A message that explains the reason for the failure, if the command failed.
status   Specifies the status of the command that was run. The result can be either success or failed.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
commandName   Specifies the name of the HTTP command interface command that was run.
Example:  { "task": { "stopOnTaskFailure": "true", "listOfServers": "time.nist.gov,10.10.2.2", "command": "ModifyNtpServers" } }
Command Type:  appliance
 
 
ModifySMTPEmail
Description:  Changes the reply-to email address that is used for sending passwords that are reset by users.
Required Parameters: 
stopOnTaskFailure   Specifies whether to stop running the batch routine when the task fails. If the value is set to true, the batch routine stops. If the value is false or blank, the batch routine does not stop. Applies to commands that are run in batch processes only.
emailAddress   Specifies the reply-to email address. Use the email address for the administrator.
Result Parameters: 
errorMessage   A message that explains the reason for the failure, if the command failed.
status   Specifies the status of the command that was run. The result can be either success or failed.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
commandName   Specifies the name of the HTTP command interface command that was run.
Example:  { "task": { "stopOnTaskFailure": "true", "command": "ModifySMTPEmail", "emailAddress": "admin@mycompany.com" } }
Command Type:  appliance
 
 
ModifySMTPServer
Description:  Changes the Simple Mail Transfer Protocol (SMTP) server.
Required Parameters: 
stopOnTaskFailure   Specifies whether to stop running the batch routine when the task fails. If the value is set to true, the batch routine stops. If the value is false or blank, the batch routine does not stop. Applies to commands that are run in batch processes only.
hostName   Specifies the SMTP host address.
Result Parameters: 
errorMessage   A message that explains the reason for the failure, if the command failed.
status   Specifies the status of the command that was run. The result can be either success or failed.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
commandName   Specifies the name of the HTTP command interface command that was run.
Example:  { "task": { "stopOnTaskFailure": "true", "command": "ModifySMTPServer", "hostName": "sicdsjc" } }
Command Type:  appliance
 
 
ModifySearchFilterUsers
Description:  Changes the Lightweight Directory Access Protocol (LDAP) search filter for users.
Required Parameters: 
stopOnTaskFailure   Specifies whether to stop running the batch routine when the task fails. If the value is set to true, the batch routine stops. If the value is false or blank, the batch routine does not stop. Applies to commands that are run in batch processes only.
ldapUserIdSearchFilterPattern   LDAP user search filter pattern.
Result Parameters: 
errorMessage   A message that explains the reason for the failure, if the command failed.
status   Specifies the status of the command that was run. The result can be either success or failed.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
commandName   Specifies the name of the HTTP command interface command that was run.
Example:  { "task": { "stopOnTaskFailure": "true", "ldapUserIdSearchFilterPattern": "(&(uid={0})(objectclass=inetOrgPerson))", "command": "ModifySearchFilterUsers" } }
Command Type:  appliance
 
 
ModifyTimeZone
Description:  Changes the time zone for the appliance.
Required Parameters: 
stopOnTaskFailure   Specifies whether to stop running the batch routine when the task fails. If the value is set to true, the batch routine stops. If the value is false or blank, the batch routine does not stop. Applies to commands that are run in batch processes only.
localTimeZone   Specifies the new time zone as an abbreviated string. Valid values: EST : Eastern Standard Time CST : Central Standard Time MST : Mountain Standard Time PST : Pacific Standard Time HAST : Hawaii AKST : Alaska AST : Atlantic UTC : Coordinated Universal Time GMT : Greenwich Mean Time CET : Central Europe EET : Eastern Europe MSK : Moscow AST_ARABIA : Arabia KRT : Pakistan IST : India NOVT : Novosibirsk CST_CHINA : China JST : Japan AWST : Australia West ACST : Australia Central AEST : Australia East
Result Parameters: 
errorMessage   A message that explains the reason for the failure, if the command failed.
status   Specifies the status of the command that was run. The result can be either success or failed.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
commandName   Specifies the name of the HTTP command interface command that was run.
Example:  { "task": { "stopOnTaskFailure": "true", "command": "ModifyTimeZone", "localTimeZone": "EST" } }
Command Type:  appliance
 
 
PingRemoteHost
Description:  Tests the visibility of a host from this appliance.
Required Parameters: 
stopOnTaskFailure   Specifies whether to stop running the batch routine when the task fails. If the value is set to true, the batch routine stops. If the value is false or blank, the batch routine does not stop. Applies to commands that are run in batch processes only.
hostName   Specifies the IP address or host name of the remote host.
Result Parameters: 
errorMessage   A message that explains the reason for the failure, if the command failed.
status   Specifies the status of the command that was run. The result can be either success or failed.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
commandName   Specifies the name of the HTTP command interface command that was run.
Example:  { "task": { "stopOnTaskFailure": "true", "command": "PingRemoteHost", "hostName": "io03.rtp.raleigh.ibm.com" } }
Command Type:  appliance
 
 
RemoveAdminTrace
Description:  Removes an existing administrative console trace string.
Required Parameters: 
stopOnTaskFailure   Specifies whether to stop running the batch routine when the task fails. If the value is set to true, the batch routine stops. If the value is false or blank, the batch routine does not stop. Applies to commands that are run in batch processes only.
traceName   Specifies the name of the trace.
Result Parameters: 
errorMessage   A message that explains the reason for the failure, if the command failed.
status   Specifies the status of the command that was run. The result can be either success or failed.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
commandName   Specifies the name of the HTTP command interface command that was run.
Example:  { "task": { "stopOnTaskFailure": "true", "traceName": "AutoCustomLogger", "command": "RemoveAdminTrace" } }
Command Type:  appliance
 
 
RemoveAggregateInterface
Description:  Deletes Aggregate Interface of a given name.
Required Parameters: 
stopOnTaskFailure   Specifies whether to stop running the batch routine when the task fails. If the value is set to true, the batch routine stops. If the value is false or blank, the batch routine does not stop. Applies to commands that are run in batch processes only.
name   Specifies the interface name.
Result Parameters: 
errorMessage   A message that explains the reason for the failure, if the command failed.
status   Specifies the status of the command that was run. The result can be either success or failed.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
commandName   Specifies the name of the HTTP command interface command that was run.
Example:  { "task": { "stopOnTaskFailure": "true", "name": "agg1", "command": "RemoveAggregateInterface" } }
Command Type:  appliance
 
 
RemoveDataCacheTrace
Description:  Removes an existing data cache trace string.
Required Parameters: 
stopOnTaskFailure   Specifies whether to stop running the batch routine when the task fails. If the value is set to true, the batch routine stops. If the value is false or blank, the batch routine does not stop. Applies to commands that are run in batch processes only.
traceName   Specifies the name of the trace.
Result Parameters: 
errorMessage   A message that explains the reason for the failure, if the command failed.
status   Specifies the status of the command that was run. The result can be either success or failed.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
commandName   Specifies the name of the HTTP command interface command that was run.
Example:  { "task": { "stopOnTaskFailure": "true", "traceName": "autoDataCacheLogger", "command": "RemoveDataCacheTrace" } }
Command Type:  appliance
 
 
RestartAppliance
Description:  Restarts or shuts down the appliance.
Required Parameters: 
immediate   Specifies if the appliance waits to complete active tasks before restarting. If the value is set to true, the appliance restarts immediately. If the value is set to false, the appliance waits for all active tasks to complete before restarting.
stopOnTaskFailure   Specifies whether to stop running the batch routine when the task fails. If the value is set to true, the batch routine stops. If the value is false or blank, the batch routine does not stop. Applies to commands that are run in batch processes only.
shutdown   Specifies if the appliance restarts or shuts down. If the value is set to true, the appliance is shut down. If the value is set to false, the appliance restarts.
Result Parameters: 
errorMessage   A message that explains the reason for the failure, if the command failed.
status   Specifies the status of the command that was run. The result can be either success or failed.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
commandName   Specifies the name of the HTTP command interface command that was run.
Example:  { "task": { "immediate": "false", "stopOnTaskFailure": "true", "command": "RestartAppliance", "shutdown": "true" } }
Command Type:  appliance
 
 
ViewAllAggregateInterfaces
Description:  Displays the information for every aggregate interface.
Required Parameters: 
stopOnTaskFailure   Specifies whether to stop running the batch routine when the task fails. If the value is set to true, the batch routine stops. If the value is false or blank, the batch routine does not stop. Applies to commands that are run in batch processes only.
Result Parameters: 
errorMessage   A message that explains the reason for the failure, if the command failed.
status   Specifies the status of the command that was run. The result can be either success or failed.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
commandName   Specifies the name of the HTTP command interface command that was run.
Example:  { "task": { "stopOnTaskFailure": "true", "command": "ViewAllAggregateInterfaces" } }
Command Type:  appliance
 
 
ViewAllEthernetInterfaces
Description:  Displays the information for every Ethernet Interface.
Required Parameters: 
stopOnTaskFailure   Specifies whether to stop running the batch routine when the task fails. If the value is set to true, the batch routine stops. If the value is false or blank, the batch routine does not stop. Applies to commands that are run in batch processes only.
Result Parameters: 
errorMessage   A message that explains the reason for the failure, if the command failed.
status   Specifies the status of the command that was run. The result can be either success or failed.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
commandName   Specifies the name of the HTTP command interface command that was run.
Example:  { "task": { "stopOnTaskFailure": "true", "command": "ViewAllEthernetInterfaces" } }
Command Type:  appliance
 
 

List of COLLECTIVE commands
 
AddApplianceToCollective
Description:  Adds an existing appliance to the current collective.
Required Parameters: 
applianceIP   Specifies the IP address of the appliance to add to the collective.
stopOnTaskFailure   Specifies whether to stop running the batch routine when the task fails. If the value is set to true, the batch routine stops. If the value is false or blank, the batch routine does not stop. Applies to commands that are run in batch processes only.
secretKey   Specifies the secret key of the appliance.
waitOnTask   Specifies whether to wait on the completion of the task associated with the command. If the value is set to true, wait on the completion of the task. If the value is set to false, do not wait on the completion of the task.
zoneName   Specifies the name of the zone to which you want to assign the appliance.
Result Parameters: 
errorMessage   A message that explains the reason for the failure, if the command failed.
status   Specifies the status of the command that was run. The result can be either success or failed.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
commandName   Specifies the name of the HTTP command interface command that was run.
Example:  { "task": { "applianceIP": "192.168.222.128", "stopOnTaskFailure": "true", "secretKey": "P5Xa4F8MQeSxuuhKxnaStw==", "waitOnTask": "true", "command": "AddApplianceToCollective", "zoneName": "DefaultZone" } }
Command Type:  collective
 
 
AddRoleToGroup
Description:  Assigns an access role to a group. The defined roles are: appliance administration, appliance monitoring, or data cache creation.
Required Parameters: 
groupName   Specifies the name of the group that is being assigned to a role.
stopOnTaskFailure   Specifies whether to stop running the batch routine when the task fails. If the value is set to true, the batch routine stops. If the value is false or blank, the batch routine does not stop. Applies to commands that are run in batch processes only.
role   Specifies the role to assign to the group. Valid values: 2 = appliance administration, 3 = appliance monitoring, 5 = data cache creation.
Result Parameters: 
errorMessage   A message that explains the reason for the failure, if the command failed.
status   Specifies the status of the command that was run. The result can be either success or failed.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
commandName   Specifies the name of the HTTP command interface command that was run.
Example:  { "task": { "stopOnTaskFailure": "true", "groupName": "autoGroup1003", "command": "AddRoleToGroup", "role": "5" } }
Command Type:  collective
 
 
AddRoleToUser
Description:  Assigns an access role to a user. The defined roles are: appliance administration, appliance monitoring, or data cache creation.
Required Parameters: 
stopOnTaskFailure   Specifies whether to stop running the batch routine when the task fails. If the value is set to true, the batch routine stops. If the value is false or blank, the batch routine does not stop. Applies to commands that are run in batch processes only.
role   Specifies the role to assign to the user. Valid values: 2 = appliance administration, 3 = appliance monitoring, 5 = data cache creation.
userName   Specifies the name of the user that is being assigned a role.
Result Parameters: 
errorMessage   A message that explains the reason for the failure, if the command failed.
status   Specifies the status of the command that was run. The result can be either success or failed.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
commandName   Specifies the name of the HTTP command interface command that was run.
Example:  { "task": { "stopOnTaskFailure": "true", "command": "AddRoleToUser", "role": "2", "userName": "autoUser1003" } }
Command Type:  collective
 
 
AddUserToGroup
Description:  Adds a user to a group. After the user is added to the group, the user has the roles that are assigned to the selected group only. Any individual user roles are lost.
Required Parameters: 
groupName   Specifies the name of a defined group.
stopOnTaskFailure   Specifies whether to stop running the batch routine when the task fails. If the value is set to true, the batch routine stops. If the value is false or blank, the batch routine does not stop. Applies to commands that are run in batch processes only.
userName   Specifies the name of a defined user.
Result Parameters: 
errorMessage   A message that explains the reason for the failure, if the command failed.
status   Specifies the status of the command that was run. The result can be either success or failed.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
commandName   Specifies the name of the HTTP command interface command that was run.
Example:  { "task": { "stopOnTaskFailure": "true", "groupName": "autoGroup1003", "command": "AddUserToGroup", "userName": "autoUser1003" } }
Command Type:  collective
 
 
CreateCollectiveLink
Description:  Creates a link to another collective.
Required Parameters: 
applianceName   Specifies the host name or IP address of an appliance that is a member of another collective.
stopOnTaskFailure   Specifies whether to stop running the batch routine when the task fails. If the value is set to true, the batch routine stops. If the value is false or blank, the batch routine does not stop. Applies to commands that are run in batch processes only.
remotePassword   Specifies the password that is used to log in to the remote appliance.
remoteUserName   Specifies the user name that is used to log in to the remote appliance.
Result Parameters: 
errorMessage   A message that explains the reason for the failure, if the command failed.
status   Specifies the status of the command that was run. The result can be either success or failed.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
commandName   Specifies the name of the HTTP command interface command that was run.
Example:  { "task": { "applianceName": "myappliance.mydomain.com", "stopOnTaskFailure": "true", "command": "CreateCollectiveLink", "remotePassword": "somePassword", "remoteUserName": "someUser" } }
Command Type:  collective
 
 
CreateGroup
Description:  Creates a new group. Groups are useful for assigning multiple users the same set of roles.
Required Parameters: 
groupName   Specifies a name for the new group. Group names must be unique.
stopOnTaskFailure   Specifies whether to stop running the batch routine when the task fails. If the value is set to true, the batch routine stops. If the value is false or blank, the batch routine does not stop. Applies to commands that are run in batch processes only.
groupDescription   Specifies a description of the group and its users.
Result Parameters: 
errorMessage   A message that explains the reason for the failure, if the command failed.
status   Specifies the status of the command that was run. The result can be either success or failed.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
commandName   Specifies the name of the HTTP command interface command that was run.
Example:  { "task": { "stopOnTaskFailure": "true", "groupName": "autoGroup1003", "groupDescription": "this group is huge", "command": "CreateGroup" } }
Command Type:  collective
 
 
CreateUser
Description:  Creates a new user.
Required Parameters: 
stopOnTaskFailure   Specifies whether to stop running the batch routine when the task fails. If the value is set to true, the batch routine stops. If the value is false or blank, the batch routine does not stop. Applies to commands that are run in batch processes only.
passwordVerification   Specifies the password, entered a second time for verification.
userPassword   Specifies a new password for the selected user.
emailAddress   Specifies an email address for the new user.
fullUserName   Specifies a full name for the user. Example: John E. Doe.
userName   Specifies a short name for the new user. Example: xcadmin.
Result Parameters: 
errorMessage   A message that explains the reason for the failure, if the command failed.
status   Specifies the status of the command that was run. The result can be either success or failed.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
commandName   Specifies the name of the HTTP command interface command that was run.
Example:  { "task": { "stopOnTaskFailure": "true", "passwordVerification": "someuserpass", "userPassword": "someuserpass", "command": "CreateUser", "emailAddress": "someuser@us.ibm.com", "fullUserName": "someuser isme", "userName": "someuser" } }
Command Type:  collective
 
 
DeleteCollectiveLink
Description:  Removes the link between the local collective and the specified collective.
Required Parameters: 
stopOnTaskFailure   Specifies whether to stop running the batch routine when the task fails. If the value is set to true, the batch routine stops. If the value is false or blank, the batch routine does not stop. Applies to commands that are run in batch processes only.
name   Specifies the name of the collective to delete.
Result Parameters: 
errorMessage   A message that explains the reason for the failure, if the command failed.
status   Specifies the status of the command that was run. The result can be either success or failed.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
commandName   Specifies the name of the HTTP command interface command that was run.
Example:  { "task": { "stopOnTaskFailure": "true", "name": "myCollectiveName", "command": "DeleteCollectiveLink" } }
Command Type:  collective
 
 
DeleteGroup
Description:  Deletes a group. Users that belonged to the group no longer belong to the group and might lose any assigned roles.
Required Parameters: 
groupName   Specifies the name of a defined group.
stopOnTaskFailure   Specifies whether to stop running the batch routine when the task fails. If the value is set to true, the batch routine stops. If the value is false or blank, the batch routine does not stop. Applies to commands that are run in batch processes only.
Result Parameters: 
errorMessage   A message that explains the reason for the failure, if the command failed.
status   Specifies the status of the command that was run. The result can be either success or failed.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
commandName   Specifies the name of the HTTP command interface command that was run.
Example:  { "task": { "stopOnTaskFailure": "true", "groupName": "autoGroup1003", "command": "DeleteGroup" } }
Command Type:  collective
 
 
DeleteUser
Description:  Deletes a user. If the user belongs to a group, the user is removed from the group.
Required Parameters: 
stopOnTaskFailure   Specifies whether to stop running the batch routine when the task fails. If the value is set to true, the batch routine stops. If the value is false or blank, the batch routine does not stop. Applies to commands that are run in batch processes only.
userName   Specifies the name of a defined user.
Result Parameters: 
errorMessage   A message that explains the reason for the failure, if the command failed.
status   Specifies the status of the command that was run. The result can be either success or failed.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
commandName   Specifies the name of the HTTP command interface command that was run.
Example:  { "task": { "stopOnTaskFailure": "true", "command": "DeleteUser", "userName": "autoUser1003" } }
Command Type:  collective
 
 
GetCollectiveName
Description:  Retrieves the collective name.
Required Parameters: 
stopOnTaskFailure   Specifies whether to stop running the batch routine when the task fails. If the value is set to true, the batch routine stops. If the value is false or blank, the batch routine does not stop. Applies to commands that are run in batch processes only.
Result Parameters: 
errorMessage   A message that explains the reason for the failure, if the command failed.
status   Specifies the status of the command that was run. The result can be either success or failed.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
commandName   Specifies the name of the HTTP command interface command that was run.
Example:  { "task": { "stopOnTaskFailure": "true", "command": "GetCollectiveName" } }
Command Type:  collective
 
 
GetHealthStatus
Description:  Displays the hardware and software Health Status information for the appliance.
Required Parameters: 
stopOnTaskFailure   Specifies whether to stop running the batch routine when the task fails. If the value is set to true, the batch routine stops. If the value is false or blank, the batch routine does not stop. Applies to commands that are run in batch processes only.
Result Parameters: 
errorMessage   A message that explains the reason for the failure, if the command failed.
status   Specifies the status of the command that was run. The result can be either success or failed.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
commandName   Specifies the name of the HTTP command interface command that was run.
Example:  { "task": { "stopOnTaskFailure": "true", "command": "GetHealthStatus" } }
Command Type:  collective
 
 
ModifyGroupDescription
Description:  Changes the description of a selected group.
Required Parameters: 
groupName   Specifies the name of a defined group.
stopOnTaskFailure   Specifies whether to stop running the batch routine when the task fails. If the value is set to true, the batch routine stops. If the value is false or blank, the batch routine does not stop. Applies to commands that are run in batch processes only.
groupDescription   Specifies a description of the group and its users.
Result Parameters: 
errorMessage   A message that explains the reason for the failure, if the command failed.
status   Specifies the status of the command that was run. The result can be either success or failed.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
commandName   Specifies the name of the HTTP command interface command that was run.
Example:  { "task": { "stopOnTaskFailure": "true", "groupName": "somegroup", "groupDescription": "somegroupdesc", "command": "ModifyGroupDescription" } }
Command Type:  collective
 
 
ModifyScheduleExportSettings
Description:  Enable and disable the scheduled exports feature. Also, specify an interval to generate a configuration export.
Required Parameters: 
dayInterval   Specifies how many days to wait in between scheduled configuration exports.
time   Specifies the scheduled date that the first export will occur. Must be in the following format: YYYY-MM-DD. For example, "2014-09-08".
stopOnTaskFailure   Specifies whether to stop running the batch routine when the task fails. If the value is set to true, the batch routine stops. If the value is false or blank, the batch routine does not stop. Applies to commands that are run in batch processes only.
enable   Specifies if the scheduled configuration export feature is enabled or disabled.
date   CLI.parameter.date.desc
Result Parameters: 
errorMessage   A message that explains the reason for the failure, if the command failed.
status   Specifies the status of the command that was run. The result can be either success or failed.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
commandName   Specifies the name of the HTTP command interface command that was run.
Example:  { "task": { "dayInterval": "3", "stopOnTaskFailure": "true", "time": "16:25", "enable": "true", "command": "ModifyScheduleExportSettings", "date": "2014-02-14" } }
Command Type:  collective
 
 
ModifyTransportAndStorageMode
Description:  Changes the transport and storage mode setting for the collective. When you update the transport and storage mode, a task is created to update the collective settings and all appliances in the collective are restarted.
Required Parameters: 
transport   Specifies the transport and storage mode. Possible values are ORB, XIO, XIO_XM. Transport and storage modes enable the exchange of objects and data between different server processes. When you enable IBM eXtremeIO (XIO), relative response time is faster than the Object Request Broker (ORB). ORB is deprecated. With XIO enabled, you can also create an enterprise data grid. With an enterprise data grid, client applications that are written in different programming languages, such as Java and .NET, can access the same data grid. When you use IBM eXtremeMemory, cache entries are stored in native memory. When you use heap memory, cache entries are stored in the Java heap.
Result Parameters: 
errorMessage   A message that explains the reason for the failure, if the command failed.
status   Specifies the status of the command that was run. The result can be either success or failed.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
commandName   Specifies the name of the HTTP command interface command that was run.
Example:  { "task": { "command": "ModifyTransportAndStorageMode", "mode": "XIO" } }
Command Type:  collective
 
 
ModifyUserEmail
Description:  Changes the email address for a user.
Required Parameters: 
stopOnTaskFailure   Specifies whether to stop running the batch routine when the task fails. If the value is set to true, the batch routine stops. If the value is false or blank, the batch routine does not stop. Applies to commands that are run in batch processes only.
emailAddress   Specifies a new email address for the user.
userName   Specifies the user name of the user to update.
Result Parameters: 
errorMessage   A message that explains the reason for the failure, if the command failed.
status   Specifies the status of the command that was run. The result can be either success or failed.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
commandName   Specifies the name of the HTTP command interface command that was run.
Example:  { "task": { "stopOnTaskFailure": "true", "command": "ModifyUserEmail", "emailAddress": "user1@mycompany.com", "userName": "user1" } }
Command Type:  collective
 
 
ModifyUserPassword
Description:  Changes the password for a specified user.
Required Parameters: 
stopOnTaskFailure   Specifies whether to stop running the batch routine when the task fails. If the value is set to true, the batch routine stops. If the value is false or blank, the batch routine does not stop. Applies to commands that are run in batch processes only.
newPassword   Specifies a new password for the selected user.
passwordVerification   Specifies the new password for the selected user, entered a second time for verification.
userName   Specifies the name of the user to update.
Result Parameters: 
errorMessage   A message that explains the reason for the failure, if the command failed.
status   Specifies the status of the command that was run. The result can be either success or failed.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
commandName   Specifies the name of the HTTP command interface command that was run.
Example:  { "task": { "stopOnTaskFailure": "true", "newPassword": "newpass", "passwordVerification": "newpass", "command": "ModifyUserPassword", "userName": "autoUser1003" } }
Command Type:  collective
 
 
RemoveApplianceFromCollective
Description:  Removes an existing appliance from the current collective.
Required Parameters: 
applianceIP   Specifies the IP address of the appliance to be removed.
stopOnTaskFailure   Specifies whether to stop running the batch routine when the task fails. If the value is set to true, the batch routine stops. If the value is false or blank, the batch routine does not stop. Applies to commands that are run in batch processes only.
waitOnTask   Specifies whether to wait on the completion of the task associated with the command. If the value is set to true, wait on the completion of the task. If the value is set to false, do not wait on the completion of the task.
Result Parameters: 
errorMessage   A message that explains the reason for the failure, if the command failed.
status   Specifies the status of the command that was run. The result can be either success or failed.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
commandName   Specifies the name of the HTTP command interface command that was run.
Example:  { "task": { "applianceIP": "192.168.222.128", "stopOnTaskFailure": "true", "waitOnTask": "true", "command": "RemoveApplianceFromCollective" } }
Command Type:  collective
 
 
RemoveRoleFromGroup
Description:  Removes an access role from a group. The defined roles are: appliance administration, appliance monitoring, or data cache creation.
Required Parameters: 
groupName   Specifies the name of the group for which you are removing an access role.
stopOnTaskFailure   Specifies whether to stop running the batch routine when the task fails. If the value is set to true, the batch routine stops. If the value is false or blank, the batch routine does not stop. Applies to commands that are run in batch processes only.
role   Specifies the role to remove from the group. Valid values: 2 = appliance administration, 3 = appliance monitoring, 5 = data cache creation.
Result Parameters: 
errorMessage   A message that explains the reason for the failure, if the command failed.
status   Specifies the status of the command that was run. The result can be either success or failed.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
commandName   Specifies the name of the HTTP command interface command that was run.
Example:  { "task": { "stopOnTaskFailure": "true", "groupName": "autoGroup1003", "command": "RemoveRoleFromGroup", "role": "5" } }
Command Type:  collective
 
 
RemoveRoleFromUser
Description:  Removes an access role from a user. The defined roles are: appliance administration, appliance monitoring, or data cache creation.
Required Parameters: 
stopOnTaskFailure   Specifies whether to stop running the batch routine when the task fails. If the value is set to true, the batch routine stops. If the value is false or blank, the batch routine does not stop. Applies to commands that are run in batch processes only.
role   Specifies the role to remove from the user. Valid values: 2 = appliance administration, 3 = appliance monitoring, 5 = data cache creation.
userName   Specifies the name of for which you are removing an access role.
Result Parameters: 
errorMessage   A message that explains the reason for the failure, if the command failed.
status   Specifies the status of the command that was run. The result can be either success or failed.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
commandName   Specifies the name of the HTTP command interface command that was run.
Example:  { "task": { "stopOnTaskFailure": "true", "command": "RemoveRoleFromUser", "role": "2", "userName": "autoUser1003" } }
Command Type:  collective
 
 
RemoveUserFromGroup
Description:  Removes a user from a group. After a user is removed from a group, the user continues to have the same roles as the group. However, the user roles for the user no longer change when the group roles change. You must modify the user roles for the selected user individually.
Required Parameters: 
groupName   Specifies the name of a defined group.
stopOnTaskFailure   Specifies whether to stop running the batch routine when the task fails. If the value is set to true, the batch routine stops. If the value is false or blank, the batch routine does not stop. Applies to commands that are run in batch processes only.
userName   Specifies the name of a defined user.
Result Parameters: 
errorMessage   A message that explains the reason for the failure, if the command failed.
status   Specifies the status of the command that was run. The result can be either success or failed.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
commandName   Specifies the name of the HTTP command interface command that was run.
Example:  { "task": { "stopOnTaskFailure": "true", "groupName": "autoGroup1003", "command": "RemoveUserFromGroup", "userName": "autoUser1003" } }
Command Type:  collective
 
 
ViewAllGroups
Description:  Displays information about all groups.
Required Parameters: 
stopOnTaskFailure   Specifies whether to stop running the batch routine when the task fails. If the value is set to true, the batch routine stops. If the value is false or blank, the batch routine does not stop. Applies to commands that are run in batch processes only.
Result Parameters: 
errorMessage   A message that explains the reason for the failure, if the command failed.
status   Specifies the status of the command that was run. The result can be either success or failed.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
commandName   Specifies the name of the HTTP command interface command that was run.
Example:  { "task": { "stopOnTaskFailure": "true", "command": "ViewAllGroups" } }
Command Type:  collective
 
 
ViewAllUsers
Description:  Displays the information for every user.
Required Parameters: 
stopOnTaskFailure   Specifies whether to stop running the batch routine when the task fails. If the value is set to true, the batch routine stops. If the value is false or blank, the batch routine does not stop. Applies to commands that are run in batch processes only.
Result Parameters: 
errorMessage   A message that explains the reason for the failure, if the command failed.
status   Specifies the status of the command that was run. The result can be either success or failed.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
commandName   Specifies the name of the HTTP command interface command that was run.
Example:  { "task": { "stopOnTaskFailure": "true", "command": "ViewAllUsers" } }
Command Type:  collective
 
 
ViewCollectiveLinks
Description:  Displays the information for every collective link.
Required Parameters: 
stopOnTaskFailure   Specifies whether to stop running the batch routine when the task fails. If the value is set to true, the batch routine stops. If the value is false or blank, the batch routine does not stop. Applies to commands that are run in batch processes only.
Result Parameters: 
errorMessage   A message that explains the reason for the failure, if the command failed.
status   Specifies the status of the command that was run. The result can be either success or failed.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
commandName   Specifies the name of the HTTP command interface command that was run.
Example:  { "task": { "stopOnTaskFailure": "true", "command": "ViewCollectiveLinks" } }
Command Type:  collective
 
 
ViewGroup
Description:  Displays information about a selected group.
Required Parameters: 
groupName   Specifies the name of a defined group.
stopOnTaskFailure   Specifies whether to stop running the batch routine when the task fails. If the value is set to true, the batch routine stops. If the value is false or blank, the batch routine does not stop. Applies to commands that are run in batch processes only.
Result Parameters: 
errorMessage   A message that explains the reason for the failure, if the command failed.
status   Specifies the status of the command that was run. The result can be either success or failed.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
commandName   Specifies the name of the HTTP command interface command that was run.
Example:  { "task": { "stopOnTaskFailure": "true", "groupName": "autoGroup1003", "command": "ViewGroup" } }
Command Type:  collective
 
 
ViewMemberDetails
Description:  Displays information about a member in a collective.
Required Parameters: 
applianceIP   Specifies the IP Address of the member.
stopOnTaskFailure   Specifies whether to stop running the batch routine when the task fails. If the value is set to true, the batch routine stops. If the value is false or blank, the batch routine does not stop. Applies to commands that are run in batch processes only.
Result Parameters: 
errorMessage   A message that explains the reason for the failure, if the command failed.
status   Specifies the status of the command that was run. The result can be either success or failed.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
commandName   Specifies the name of the HTTP command interface command that was run.
Example:  { "task": { "applianceIP": "192.168.222.128", "stopOnTaskFailure": "true", "command": "ViewMemberDetails" } }
Command Type:  collective
 
 
ViewTransportAndStorageMode
Description:  Displays the transport and storage mode.
Required Parameters: 
Result Parameters: 
errorMessage   A message that explains the reason for the failure, if the command failed.
status   Specifies the status of the command that was run. The result can be either success or failed.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
commandName   Specifies the name of the HTTP command interface command that was run.
Example:  { "task": { "command": "ViewTransportAndStorageMode" } }
Command Type:  collective
 
 
ViewUser
Description:  Displays information about a selected user.
Required Parameters: 
stopOnTaskFailure   Specifies whether to stop running the batch routine when the task fails. If the value is set to true, the batch routine stops. If the value is false or blank, the batch routine does not stop. Applies to commands that are run in batch processes only.
userName   Specifies the name of a defined user.
Result Parameters: 
errorMessage   A message that explains the reason for the failure, if the command failed.
status   Specifies the status of the command that was run. The result can be either success or failed.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
commandName   Specifies the name of the HTTP command interface command that was run.
Example:  { "task": { "stopOnTaskFailure": "true", "command": "ViewUser", "userName": "autoUser1003" } }
Command Type:  collective
 
 

List of GRID commands
 
ClearGrid
Description:  Clears data from a data grid.
Required Parameters: 
stopOnTaskFailure   Specifies whether to stop running the batch routine when the task fails. If the value is set to true, the batch routine stops. If the value is false or blank, the batch routine does not stop. Applies to commands that are run in batch processes only.
gridName   Specifies the name of the data grid to be cleared.
Result Parameters: 
errorMessage   A message that explains the reason for the failure, if the command failed.
status   Specifies the status of the command that was run. The result can be either success or failed.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
commandName   Specifies the name of the HTTP command interface command that was run.
Example:  { "task": { "stopOnTaskFailure": "true", "gridName": "myGrid", "command": "ClearGrid" } }
Command Type:  grid
 
 
CreateGrid
Description:  Creates a new simple, dynamic cache, or session data grid.
Required Parameters: 
stopOnTaskFailure   Specifies whether to stop running the batch routine when the task fails. If the value is set to true, the batch routine stops. If the value is false or blank, the batch routine does not stop. Applies to commands that are run in batch processes only.
gridName   Specifies the name of the data grid to create.
waitOnTask   Specifies whether to wait on the completion of the task associated with the command. If the value is set to true, wait on the completion of the task. If the value is set to false, do not wait on the completion of the task.
gridType   Specifies the type of data grid to create. Valid values: simple, dynamic, or session.
Result Parameters: 
errorMessage   A message that explains the reason for the failure, if the command failed.
status   Specifies the status of the command that was run. The result can be either success or failed.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
commandName   Specifies the name of the HTTP command interface command that was run.
Example:  { "task": { "stopOnTaskFailure": "true", "gridName": "myGrid", "waitOnTask": "true", "command": "CreateGrid", "gridType": "simple" } }
Command Type:  grid
 
 
DeleteGrid
Description:  Deletes a data grid.
Required Parameters: 
stopOnTaskFailure   Specifies whether to stop running the batch routine when the task fails. If the value is set to true, the batch routine stops. If the value is false or blank, the batch routine does not stop. Applies to commands that are run in batch processes only.
gridName   Specifies the name of the data grid to delete.
waitOnTask   Specifies whether to wait on the completion of the task associated with the command. If the value is set to true, wait on the completion of the task. If the value is set to false, do not wait on the completion of the task.
Result Parameters: 
errorMessage   A message that explains the reason for the failure, if the command failed.
status   Specifies the status of the command that was run. The result can be either success or failed.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
commandName   Specifies the name of the HTTP command interface command that was run.
Example:  { "task": { "stopOnTaskFailure": "true", "gridName": "myGrid", "command": "DeleteGrid" } }
Command Type:  grid
 
 
ExportGrid
Description:  (Simple data grids only) Exports data grid information to XML.
Required Parameters: 
stopOnTaskFailure   Specifies whether to stop running the batch routine when the task fails. If the value is set to true, the batch routine stops. If the value is false or blank, the batch routine does not stop. Applies to commands that are run in batch processes only.
gridName   Specifies the name of the data grid to export.
Result Parameters: 
errorMessage   A message that explains the reason for the failure, if the command failed.
status   Specifies the status of the command that was run. The result can be either success or failed.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
commandName   Specifies the name of the HTTP command interface command that was run.
Example:  { "task": { "stopOnTaskFailure": "true", "gridName": "myGrid", "command": "ExportGrid" } }
Command Type:  grid
 
 
GrantGroupAccess
Description:  Gives a group access rights to a data grid.
Required Parameters: 
groupName   Specifies the name of the group to grant the given access rights.
stopOnTaskFailure   Specifies whether to stop running the batch routine when the task fails. If the value is set to true, the batch routine stops. If the value is false or blank, the batch routine does not stop. Applies to commands that are run in batch processes only.
gridName   Specifies the name of the data grid to grant access rights.
Result Parameters: 
errorMessage   A message that explains the reason for the failure, if the command failed.
status   Specifies the status of the command that was run. The result can be either success or failed.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
commandName   Specifies the name of the HTTP command interface command that was run.
Example:  { "task": { "stopOnTaskFailure": "true", "groupName": "somegroup", "gridName": "myGrid", "command": "GrantGroupAccess" } }
Command Type:  grid
 
 
GrantUserAccess
Description:  Gives a user access rights to a data grid.
Required Parameters: 
stopOnTaskFailure   Specifies whether to stop running the batch routine when the task fails. If the value is set to true, the batch routine stops. If the value is false or blank, the batch routine does not stop. Applies to commands that are run in batch processes only.
gridName   Specifies the name of the data grid to which the user is assigned access.
userName   Specifies the name of the user to give access rights.
Result Parameters: 
errorMessage   A message that explains the reason for the failure, if the command failed.
status   Specifies the status of the command that was run. The result can be either success or failed.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
commandName   Specifies the name of the HTTP command interface command that was run.
Example:  { "task": { "stopOnTaskFailure": "true", "gridName": "myGrid", "command": "GrantUserAccess", "userName": "someuser" } }
Command Type:  grid
 
 
ModifyGridCapacity
Description:  Changes the capacity for a simple data grid.
Required Parameters: 
stopOnTaskFailure   Specifies whether to stop running the batch routine when the task fails. If the value is set to true, the batch routine stops. If the value is false or blank, the batch routine does not stop. Applies to commands that are run in batch processes only.
useLRU   (Simple data grids only) Enables least recently used (LRU) eviction when set to true.
gridName   Specifies the name of the data grid to update.
waitOnTask   Specifies whether to wait on the completion of the task associated with the command. If the value is set to true, wait on the completion of the task. If the value is set to false, do not wait on the completion of the task.
gridCapLimit   Specifies the maximum capacity for the selected data grid in megabytes.
Result Parameters: 
errorMessage   A message that explains the reason for the failure, if the command failed.
status   Specifies the status of the command that was run. The result can be either success or failed.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
commandName   Specifies the name of the HTTP command interface command that was run.
Example:  { "task": { "stopOnTaskFailure": "true", "useLRU": "false", "gridName": "myGrid", "waitOnTask": "true", "command": "ModifyGridCapacity", "gridCapLimit": "10" } }
Command Type:  grid
 
 
ModifyGridReplication
Description:  Changes the replication settings for a data grid.
Required Parameters: 
stopOnTaskFailure   Specifies whether to stop running the batch routine when the task fails. If the value is set to true, the batch routine stops. If the value is false or blank, the batch routine does not stop. Applies to commands that are run in batch processes only.
gridName   Specifies the name of the data grid to update.
maximumSyncReplicas   Specifies the maximum number of synchronous replicas for this data grid.
waitOnTask   Specifies whether to wait on the completion of the task associated with the command. If the value is set to true, wait on the completion of the task. If the value is set to false, do not wait on the completion of the task.
maximumAsyncReplicas   Specifies the maximum number of asynchronous replicas for this data grid.
Result Parameters: 
errorMessage   A message that explains the reason for the failure, if the command failed.
status   Specifies the status of the command that was run. The result can be either success or failed.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
commandName   Specifies the name of the HTTP command interface command that was run.
Example:  { "task": { "stopOnTaskFailure": "true", "gridName": "myGrid", "waitOnTask": "true", "maximumSyncReplicas": "4", "command": "ModifyGridReplication", "maximumAsyncReplicas": "2" } }
Command Type:  grid
 
 
ModifyGridSecurity
Description:  Changes the security settings for a data grid.
Required Parameters: 
stopOnTaskFailure   Specifies whether to stop running the batch routine when the task fails. If the value is set to true, the batch routine stops. If the value is false or blank, the batch routine does not stop. Applies to commands that are run in batch processes only.
authorizationEnabled   Enables authorization for the data grid when set to true.
gridName   Specifies the name of the data grid to update.
waitOnTask   Specifies whether to wait on the completion of the task associated with the command. If the value is set to true, wait on the completion of the task. If the value is set to false, do not wait on the completion of the task.
securityEnabled   Enables security for the data grid when set to true.
Result Parameters: 
errorMessage   A message that explains the reason for the failure, if the command failed.
status   Specifies the status of the command that was run. The result can be either success or failed.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
commandName   Specifies the name of the HTTP command interface command that was run.
Example:  { "task": { "stopOnTaskFailure": "true", "authorizationEnabled": "false", "gridName": "myGrid", "waitOnTask": "true", "command": "ModifyGridSecurity", "securityEnabled": "false" } }
Command Type:  grid
 
 
ModifyGridTTL
Description:  (Simple data grids only) Changes time to live (TTL) settings for the data grid.
Required Parameters: 
defaultMapEvictorType   (Optional) Specifies the time to live eviction type used for the default map. Valid values: NONE, CREATION_TIME, LAST_ACCESS_TIME, LAST_UPDATE_TIME.
stopOnTaskFailure   Specifies whether to stop running the batch routine when the task fails. If the value is set to true, the batch routine stops. If the value is false or blank, the batch routine does not stop. Applies to commands that are run in batch processes only.
gridName   Specifies the name of the data grid to update.
waitOnTask   Specifies whether to wait on the completion of the task associated with the command. If the value is set to true, wait on the completion of the task. If the value is set to false, do not wait on the completion of the task.
gridTTL   Specifies the amount of time, in seconds, to keep data before evicting the data from data grid.
Result Parameters: 
errorMessage   A message that explains the reason for the failure, if the command failed.
status   Specifies the status of the command that was run. The result can be either success or failed.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
commandName   Specifies the name of the HTTP command interface command that was run.
Example:  { "task": { "defaultMapEvictorType": "CREATION_TIME", "stopOnTaskFailure": "true", "gridName": "myGrid", "waitOnTask": "true", "command": "ModifyGridTTL", "gridTTL": "60000" } }
Command Type:  grid
 
 
ModifyGroupAccess
Description:  Changes the group access rights for a data grid.
Required Parameters: 
groupName   Specifies the name of the group for which you want to modify access rights.
stopOnTaskFailure   Specifies whether to stop running the batch routine when the task fails. If the value is set to true, the batch routine stops. If the value is false or blank, the batch routine does not stop. Applies to commands that are run in batch processes only.
gridName   Specifies the name of the data grid to update.
accessType   Specifies the type of access to give to the group. Valid values: 1 = read, 2 = write, 3 = create, 4 = all.
Result Parameters: 
errorMessage   A message that explains the reason for the failure, if the command failed.
status   Specifies the status of the command that was run. The result can be either success or failed.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
commandName   Specifies the name of the HTTP command interface command that was run.
Example:  { "task": { "stopOnTaskFailure": "true", "groupName": "somegroup", "gridName": "myGrid", "command": "ModifyGroupAccess", "accessType": "1" } }
Command Type:  grid
 
 
ModifyUserAccess
Description:  Changes user access rights for a data grid.
Required Parameters: 
stopOnTaskFailure   Specifies whether to stop running the batch routine when the task fails. If the value is set to true, the batch routine stops. If the value is false or blank, the batch routine does not stop. Applies to commands that are run in batch processes only.
gridName   Specifies the name of the data grid to update.
userName   Specifies the name of the user for which access rights are being updated.
accessType   Specifies the type of access to give to the user. Valid values: 1 = read, 2 = write, 3 = create, 4 = all.
Result Parameters: 
errorMessage   A message that explains the reason for the failure, if the command failed.
status   Specifies the status of the command that was run. The result can be either success or failed.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
commandName   Specifies the name of the HTTP command interface command that was run.
Example:  { "task": { "stopOnTaskFailure": "true", "gridName": "myGrid", "command": "ModifyUserAccess", "userName": "someuser", "accessType": "1" } }
Comman