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

 
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: 
status   Specifies the status of the command that was run. The result can be either success or failed.
commandName   Specifies the name of the HTTP command interface command that was run.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
errorMessage   A message that explains the reason for the failure, if the command failed.
Example:  { "task": { "stopOnTaskFailure": "true", "emailAddress": "admin@mycompany.com", "command": "ModifySMTPEmail" } }
Command Type:  appliance
 
 
PingRemoteHost
Description:  Tests the visibility of a host from this appliance.
Required Parameters: 
hostName   Specifies the IP address or host name of the remote host.
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: 
status   Specifies the status of the command that was run. The result can be either success or failed.
commandName   Specifies the name of the HTTP command interface command that was run.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
errorMessage   A message that explains the reason for the failure, if the command failed.
Example:  { "task": { "hostName": "io03.rtp.raleigh.ibm.com", "stopOnTaskFailure": "true", "command": "PingRemoteHost" } }
Command Type:  appliance
 
 
CreateAdminTrace
Description:  Adds or modifies an existing administrative trace string.
Required Parameters: 
traceName   Specifies the name of the trace.
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: 
status   Specifies the status of the command that was run. The result can be either success or failed.
commandName   Specifies the name of the HTTP command interface command that was run.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
errorMessage   A message that explains the reason for the failure, if the command failed.
Example:  { "task": { "traceName": "AutoCustomLogger", "stopOnTaskFailure": "true", "command": "CreateAdminTrace" } }
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.
passwordVerification   Specifies a new default administrator account password, entered a second time for verification.
newPassword   Specifies a new default administrator account password.
Result Parameters: 
status   Specifies the status of the command that was run. The result can be either success or failed.
commandName   Specifies the name of the HTTP command interface command that was run.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
errorMessage   A message that explains the reason for the failure, if the command failed.
Example:  { "task": { "stopOnTaskFailure": "true", "passwordVerification": "somepass", "newPassword": "somepass", "command": "ModifyAdministratorPassword" } }
Command Type:  appliance
 
 
ModifySearchFilterUsers
Description:  Changes the Lightweight Directory Access Protocol (LDAP) search filter for users.
Required Parameters: 
ldapUserIdSearchFilterPattern   LDAP user search filter pattern.
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: 
status   Specifies the status of the command that was run. The result can be either success or failed.
commandName   Specifies the name of the HTTP command interface command that was run.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
errorMessage   A message that explains the reason for the failure, if the command failed.
Example:  { "task": { "ldapUserIdSearchFilterPattern": "(&(uid={0})(objectclass=inetOrgPerson))", "stopOnTaskFailure": "true", "command": "ModifySearchFilterUsers" } }
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: 
enable   Enables the password to be reset. Set the value to true to enable password resets.
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: 
status   Specifies the status of the command that was run. The result can be either success or failed.
commandName   Specifies the name of the HTTP command interface command that was run.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
errorMessage   A message that explains the reason for the failure, if the command failed.
Example:  { "task": { "enable": "true", "stopOnTaskFailure": "true", "command": "EnablePasswordReset" } }
Command Type:  appliance
 
 
EnableCreateAccount
Description:  Enables a setting that allows users to initiate the creation of their own accounts.
Required Parameters: 
enable   Enables account creation. Set the value to false to disable account creation. Set the value to true to enable account creation.
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: 
status   Specifies the status of the command that was run. The result can be either success or failed.
commandName   Specifies the name of the HTTP command interface command that was run.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
errorMessage   A message that explains the reason for the failure, if the command failed.
Example:  { "task": { "enable": "true", "stopOnTaskFailure": "true", "command": "EnableCreateAccount" } }
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: 
status   Specifies the status of the command that was run. The result can be either success or failed.
commandName   Specifies the name of the HTTP command interface command that was run.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
errorMessage   A message that explains the reason for the failure, if the command failed.
Example:  { "task": { "stopOnTaskFailure": "true", "command": "ModifyAdminDefaultTrace", "traceLevel": "SEVERE" } }
Command Type:  appliance
 
 
EnableSNMP
Description:  Enables or disables Simple Network Management Protocol (SNMP).
Required Parameters: 
enable   Enables SNMP. Set the value to false to disable SNMP. Set the value to true to enable SNMP.
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: 
status   Specifies the status of the command that was run. The result can be either success or failed.
commandName   Specifies the name of the HTTP command interface command that was run.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
errorMessage   A message that explains the reason for the failure, if the command failed.
Example:  { "task": { "enable": "true", "stopOnTaskFailure": "true", "command": "EnableSNMP" } }
Command Type:  appliance
 
 
RemoveDataCacheTrace
Description:  Removes an existing data cache trace string.
Required Parameters: 
traceName   Specifies the name of the trace.
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: 
status   Specifies the status of the command that was run. The result can be either success or failed.
commandName   Specifies the name of the HTTP command interface command that was run.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
errorMessage   A message that explains the reason for the failure, if the command failed.
Example:  { "task": { "traceName": "autoDataCacheLogger", "stopOnTaskFailure": "true", "command": "RemoveDataCacheTrace" } }
Command Type:  appliance
 
 
ModifySMTPServer
Description:  Changes the Simple Mail Transfer Protocol (SMTP) server.
Required Parameters: 
hostName   Specifies the SMTP host address.
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: 
status   Specifies the status of the command that was run. The result can be either success or failed.
commandName   Specifies the name of the HTTP command interface command that was run.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
errorMessage   A message that explains the reason for the failure, if the command failed.
Example:  { "task": { "hostName": "sicdsjc", "stopOnTaskFailure": "true", "command": "ModifySMTPServer" } }
Command Type:  appliance
 
 
DeleteSNMPCommunity
Description:  Deletes a Simple Network Management Protocol (SNMP) community.
Required Parameters: 
communityName   Specifies the name of SNMP community to delete.
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: 
status   Specifies the status of the command that was run. The result can be either success or failed.
commandName   Specifies the name of the HTTP command interface command that was run.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
errorMessage   A message that explains the reason for the failure, if the command failed.
Example:  { "task": { "stopOnTaskFailure": "true", "communityName": "autocommunity", "command": "DeleteSNMPCommunity" } }
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: 
status   Specifies the status of the command that was run. The result can be either success or failed.
commandName   Specifies the name of the HTTP command interface command that was run.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
errorMessage   A message that explains the reason for the failure, if the command failed.
Example:  { "task": { "immediate": "false", "stopOnTaskFailure": "true", "shutdown": "true", "command": "RestartAppliance" } }
Command Type:  appliance
 
 
RemoveAdminTrace
Description:  Removes an existing administrative console trace string.
Required Parameters: 
traceName   Specifies the name of the trace.
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: 
status   Specifies the status of the command that was run. The result can be either success or failed.
commandName   Specifies the name of the HTTP command interface command that was run.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
errorMessage   A message that explains the reason for the failure, if the command failed.
Example:  { "task": { "traceName": "AutoCustomLogger", "stopOnTaskFailure": "true", "command": "RemoveAdminTrace" } }
Command Type:  appliance
 
 
ModifyAdminTrace
Description:  Changes an administrative logger trace level.
Required Parameters: 
traceName   Specifies the name of the trace to modify.
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.
Result Parameters: 
status   Specifies the status of the command that was run. The result can be either success or failed.
commandName   Specifies the name of the HTTP command interface command that was run.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
errorMessage   A message that explains the reason for the failure, if the command failed.
Example:  { "task": { "traceName": "autoCustomLogger", "stopOnTaskFailure": "true", "command": "ModifyAdminTrace", "traceLevel": "SEVERE" } }
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: 
status   Specifies the status of the command that was run. The result can be either success or failed.
commandName   Specifies the name of the HTTP command interface command that was run.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
errorMessage   A message that explains the reason for the failure, if the command failed.
Example:  { "task": { "stopOnTaskFailure": "true", "administratorName": "somenewname", "command": "ModifyAdministratorName" } }
Command Type:  appliance
 
 
ModifyDataCacheTrace
Description:  Adds or modifies an existing data cache trace string.
Required Parameters: 
traceName   Specifies the name of the trace.
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.
Result Parameters: 
status   Specifies the status of the command that was run. The result can be either success or failed.
commandName   Specifies the name of the HTTP command interface command that was run.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
errorMessage   A message that explains the reason for the failure, if the command failed.
Example:  { "task": { "traceName": "autoDataCacheLogger", "stopOnTaskFailure": "true", "command": "ModifyDataCacheTrace", "traceLevel": "SEVERE" } }
Command Type:  appliance
 
 
ModifyTimeZone
Description:  Changes the time zone for the appliance.
Required Parameters: 
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
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: 
status   Specifies the status of the command that was run. The result can be either success or failed.
commandName   Specifies the name of the HTTP command interface command that was run.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
errorMessage   A message that explains the reason for the failure, if the command failed.
Example:  { "task": { "stopOnTaskFailure": "true", "localTimeZone": "EST", "command": "ModifyTimeZone" } }
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: 
status   Specifies the status of the command that was run. The result can be either success or failed.
commandName   Specifies the name of the HTTP command interface command that was run.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
errorMessage   A message that explains the reason for the failure, if the command failed.
Example:  { "task": { "stopOnTaskFailure": "true", "listOfServers": "time.nist.gov,10.10.2.2", "command": "ModifyNtpServers" } }
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.
communityName   Specifies the name of the SNMP community to create.
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: 
status   Specifies the status of the command that was run. The result can be either success or failed.
commandName   Specifies the name of the HTTP command interface command that was run.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
errorMessage   A message that explains the reason for the failure, if the command failed.
Example:  { "task": { "stopOnTaskFailure": "true", "hostRestriction": "autorestriction", "communityName": "autocommunity", "command": "CreateSNMPCommunity" } }
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: 
status   Specifies the status of the command that was run. The result can be either success or failed.
commandName   Specifies the name of the HTTP command interface command that was run.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
errorMessage   A message that explains the reason for the failure, if the command failed.
Example:  { "task": { "stopOnTaskFailure": "true", "command": "ModifyAdministratorEmail", "administratorEmail": "somenewname@us.ibm.com" } }
Command Type:  appliance
 
 
CreateDataCacheTrace
Description:  Adds or modifies an existing data cache trace string.
Required Parameters: 
traceName   Specifies the name of the trace.
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: 
status   Specifies the status of the command that was run. The result can be either success or failed.
commandName   Specifies the name of the HTTP command interface command that was run.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
errorMessage   A message that explains the reason for the failure, if the command failed.
Example:  { "task": { "traceName": "autoDataCacheLogger", "stopOnTaskFailure": "true", "command": "CreateDataCacheTrace" } }
Command Type:  appliance
 
 
ModifyLDAP
Description:  Configures the appliance to use Lightweight Directory Access Protocol (LDAP) for user login authentication.
Required Parameters: 
ldapUserIdSearchFilterPattern   LDAP user search filter pattern.
enable   Specifies if LDAP user authentication is enabled. Set the value to true to enable LDAP user authentication.
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.
jndiProviderURL   Specifies the URL for the LDAP provider.
jndiSecurityPrincipal   Specifies the JNDI security principal.
userBaseDn   Specifies the LDAP JNDI base distinguished name (DN) for users.
passwordVerification   Specifies the new LDAP password a second time for password verification. The value must be the same as the newPassword parameter.
groupBaseDn   Specifies the LDAP JNDI base distinguished name (DN) for groups.
newPassword   Specifies the new LDAP password.
Result Parameters: 
status   Specifies the status of the command that was run. The result can be either success or failed.
commandName   Specifies the name of the HTTP command interface command that was run.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
errorMessage   A message that explains the reason for the failure, if the command failed.
Example:  { "task": { "ldapUserIdSearchFilterPattern": "thefilterpattern", "enable": "true", "stopOnTaskFailure": "true", "jndiProviderURL": "someurl", "jndiSecurityPrincipal": "CN=Administrator,CN=users,DC=mycompany,DC=com", "userBaseDn": "cn=user", "passwordVerification": "somepassword", "groupBaseDn": "cn=group", "newPassword": "somepassword", "command": "ModifyLDAP" } }
Command Type:  appliance
 
 

List of COLLECTIVE commands

 
AddRoleToGroup
Description:  Assigns an access role to a group. 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 group. Valid values: 2 = appliance administration, 3 = appliance monitoring, 5 = data cache creation.
groupName   Specifies the name of the group that is being assigned to a role.
Result Parameters: 
status   Specifies the status of the command that was run. The result can be either success or failed.
commandName   Specifies the name of the HTTP command interface command that was run.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
errorMessage   A message that explains the reason for the failure, if the command failed.
Example:  { "task": { "stopOnTaskFailure": "true", "role": "5", "groupName": "autoGroup1003", "command": "AddRoleToGroup" } }
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: 
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.
groupName   Specifies the name of a defined group.
Result Parameters: 
status   Specifies the status of the command that was run. The result can be either success or failed.
commandName   Specifies the name of the HTTP command interface command that was run.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
errorMessage   A message that explains the reason for the failure, if the command failed.
Example:  { "task": { "stopOnTaskFailure": "true", "groupName": "autoGroup1003", "command": "DeleteGroup" } }
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: 
status   Specifies the status of the command that was run. The result can be either success or failed.
commandName   Specifies the name of the HTTP command interface command that was run.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
errorMessage   A message that explains the reason for the failure, if the command failed.
Example:  { "task": { "stopOnTaskFailure": "true", "command": "GetCollectiveName" } }
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: 
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.
groupName   Specifies the name of a defined group.
Result Parameters: 
status   Specifies the status of the command that was run. The result can be either success or failed.
commandName   Specifies the name of the HTTP command interface command that was run.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
errorMessage   A message that explains the reason for the failure, if the command failed.
Example:  { "task": { "stopOnTaskFailure": "true", "userName": "autoUser1003", "groupName": "autoGroup1003", "command": "AddUserToGroup" } }
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: 
status   Specifies the status of the command that was run. The result can be either success or failed.
commandName   Specifies the name of the HTTP command interface command that was run.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
errorMessage   A message that explains the reason for the failure, if the command failed.
Example:  { "task": { "stopOnTaskFailure": "true", "applianceIP": "192.168.222.128", "command": "ViewMemberDetails" } }
Command Type:  collective
 
 
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.
zoneName   Specifies the name of the zone to which you want to assign 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.
secretKey   Specifies the secret key of the appliance.
Result Parameters: 
status   Specifies the status of the command that was run. The result can be either success or failed.
commandName   Specifies the name of the HTTP command interface command that was run.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
errorMessage   A message that explains the reason for the failure, if the command failed.
Example:  { "task": { "stopOnTaskFailure": "true", "applianceIP": "192.168.222.128", "zoneName": "DefaultZone", "waitOnTask": "true", "command": "AddApplianceToCollective", "secretKey": "P5Xa4F8MQeSxuuhKxnaStw==" } }
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: 
status   Specifies the status of the command that was run. The result can be either success or failed.
commandName   Specifies the name of the HTTP command interface command that was run.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
errorMessage   A message that explains the reason for the failure, if the command failed.
Example:  { "task": { "stopOnTaskFailure": "true", "applianceIP": "192.168.222.128", "waitOnTask": "true", "command": "RemoveApplianceFromCollective" } }
Command Type:  collective
 
 
CreateCollectiveLink
Description:  Creates a link to another collective.
Required Parameters: 
remotePassword   Specifies the password that is used to log in to the remote appliance.
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.
applianceName   Specifies the host name or IP address of an appliance that is a member of another collective.
remoteUserName   Specifies the user name that is used to log in to the remote appliance.
Result Parameters: 
status   Specifies the status of the command that was run. The result can be either success or failed.
commandName   Specifies the name of the HTTP command interface command that was run.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
errorMessage   A message that explains the reason for the failure, if the command failed.
Example:  { "task": { "remotePassword": "somePassword", "stopOnTaskFailure": "true", "applianceName": "myappliance.mydomain.com", "command": "CreateCollectiveLink", "remoteUserName": "someUser" } }
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: 
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.
groupName   Specifies the name of the group for which you are removing an access role.
Result Parameters: 
status   Specifies the status of the command that was run. The result can be either success or failed.
commandName   Specifies the name of the HTTP command interface command that was run.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
errorMessage   A message that explains the reason for the failure, if the command failed.
Example:  { "task": { "stopOnTaskFailure": "true", "role": "5", "groupName": "autoGroup1003", "command": "RemoveRoleFromGroup" } }
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: 
status   Specifies the status of the command that was run. The result can be either success or failed.
commandName   Specifies the name of the HTTP command interface command that was run.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
errorMessage   A message that explains the reason for the failure, if the command failed.
Example:  { "task": { "stopOnTaskFailure": "true", "name": "myCollectiveName", "command": "DeleteCollectiveLink" } }
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.
fullUserName   Specifies a full name for the user. Example: John E. Doe.
passwordVerification   Specifies the password, entered a second time for verification.
userPassword   Specifies a new password for the selected user.
userName   Specifies a short name for the new user. Example: xcadmin.
emailAddress   Specifies an email address for the new user.
Result Parameters: 
status   Specifies the status of the command that was run. The result can be either success or failed.
commandName   Specifies the name of the HTTP command interface command that was run.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
errorMessage   A message that explains the reason for the failure, if the command failed.
Example:  { "task": { "stopOnTaskFailure": "true", "fullUserName": "someuser isme", "passwordVerification": "someuserpass", "userPassword": "someuserpass", "userName": "someuser", "emailAddress": "someuser@us.ibm.com", "command": "CreateUser" } }
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: 
status   Specifies the status of the command that was run. The result can be either success or failed.
commandName   Specifies the name of the HTTP command interface command that was run.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
errorMessage   A message that explains the reason for the failure, if the command failed.
Example:  { "task": { "stopOnTaskFailure": "true", "userName": "autoUser1003", "command": "DeleteUser" } }
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: 
status   Specifies the status of the command that was run. The result can be either success or failed.
commandName   Specifies the name of the HTTP command interface command that was run.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
errorMessage   A message that explains the reason for the failure, if the command failed.
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: 
status   Specifies the status of the command that was run. The result can be either success or failed.
commandName   Specifies the name of the HTTP command interface command that was run.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
errorMessage   A message that explains the reason for the failure, if the command failed.
Example:  { "task": { "stopOnTaskFailure": "true", "command": "ViewAllUsers" } }
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: 
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.
groupName   Specifies the name of a defined group.
Result Parameters: 
status   Specifies the status of the command that was run. The result can be either success or failed.
commandName   Specifies the name of the HTTP command interface command that was run.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
errorMessage   A message that explains the reason for the failure, if the command failed.
Example:  { "task": { "stopOnTaskFailure": "true", "userName": "autoUser1003", "groupName": "autoGroup1003", "command": "RemoveUserFromGroup" } }
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.
userName   Specifies the user name of the user to update.
emailAddress   Specifies a new email address for the user.
Result Parameters: 
status   Specifies the status of the command that was run. The result can be either success or failed.
commandName   Specifies the name of the HTTP command interface command that was run.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
errorMessage   A message that explains the reason for the failure, if the command failed.
Example:  { "task": { "stopOnTaskFailure": "true", "userName": "user1", "emailAddress": "user1@mycompany.com", "command": "ModifyUserEmail" } }
Command Type:  collective
 
 
CreateGroup
Description:  Creates a new group. Groups are useful for assigning multiple users the same set of roles.
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.
groupName   Specifies a name for the new group. Group names must be unique.
groupDescription   Specifies a description of the group and its users.
Result Parameters: 
status   Specifies the status of the command that was run. The result can be either success or failed.
commandName   Specifies the name of the HTTP command interface command that was run.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
errorMessage   A message that explains the reason for the failure, if the command failed.
Example:  { "task": { "stopOnTaskFailure": "true", "groupName": "autoGroup1003", "command": "CreateGroup", "groupDescription": "this group is huge" } }
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: 
status   Specifies the status of the command that was run. The result can be either success or failed.
commandName   Specifies the name of the HTTP command interface command that was run.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
errorMessage   A message that explains the reason for the failure, if the command failed.
Example:  { "task": { "stopOnTaskFailure": "true", "userName": "autoUser1003", "command": "ViewUser" } }
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: 
status   Specifies the status of the command that was run. The result can be either success or failed.
commandName   Specifies the name of the HTTP command interface command that was run.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
errorMessage   A message that explains the reason for the failure, if the command failed.
Example:  { "task": { "stopOnTaskFailure": "true", "role": "2", "userName": "autoUser1003", "command": "AddRoleToUser" } }
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.
passwordVerification   Specifies the new password for the selected user, entered a second time for verification.
userName   Specifies the name of the user to update.
newPassword   Specifies a new password for the selected user.
Result Parameters: 
status   Specifies the status of the command that was run. The result can be either success or failed.
commandName   Specifies the name of the HTTP command interface command that was run.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
errorMessage   A message that explains the reason for the failure, if the command failed.
Example:  { "task": { "stopOnTaskFailure": "true", "passwordVerification": "newpass", "userName": "autoUser1003", "newPassword": "newpass", "command": "ModifyUserPassword" } }
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 the user for which you are removing an access role.
Result Parameters: 
status   Specifies the status of the command that was run. The result can be either success or failed.
commandName   Specifies the name of the HTTP command interface command that was run.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
errorMessage   A message that explains the reason for the failure, if the command failed.
Example:  { "task": { "stopOnTaskFailure": "true", "role": "2", "userName": "autoUser1003", "command": "RemoveRoleFromUser" } }
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: 
status   Specifies the status of the command that was run. The result can be either success or failed.
commandName   Specifies the name of the HTTP command interface command that was run.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
errorMessage   A message that explains the reason for the failure, if the command failed.
Example:  { "task": { "stopOnTaskFailure": "true", "command": "ViewCollectiveLinks" } }
Command Type:  collective
 
 
ViewGroup
Description:  Displays information about a selected 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.
groupName   Specifies the name of a defined group.
Result Parameters: 
status   Specifies the status of the command that was run. The result can be either success or failed.
commandName   Specifies the name of the HTTP command interface command that was run.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
errorMessage   A message that explains the reason for the failure, if the command failed.
Example:  { "task": { "stopOnTaskFailure": "true", "groupName": "autoGroup1003", "command": "ViewGroup" } }
Command Type:  collective
 
 
ModifyGroupDescription
Description:  Changes the description of a selected 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.
groupName   Specifies the name of a defined group.
groupDescription   Specifies a description of the group and its users.
Result Parameters: 
status   Specifies the status of the command that was run. The result can be either success or failed.
commandName   Specifies the name of the HTTP command interface command that was run.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
errorMessage   A message that explains the reason for the failure, if the command failed.
Example:  { "task": { "stopOnTaskFailure": "true", "groupName": "somegroup", "command": "ModifyGroupDescription", "groupDescription": "somegroupdesc" } }
Command Type:  collective
 
 

List of GRID commands

 
ModifyGridSecurity
Description:  Changes the security settings for a data grid.
Required Parameters: 
securityEnabled   Enables security for the data grid when set to true.
gridName   Specifies the name of the data grid to update.
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.
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: 
status   Specifies the status of the command that was run. The result can be either success or failed.
commandName   Specifies the name of the HTTP command interface command that was run.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
errorMessage   A message that explains the reason for the failure, if the command failed.
Example:  { "task": { "securityEnabled": "false", "gridName": "myGrid", "stopOnTaskFailure": "true", "authorizationEnabled": "false", "waitOnTask": "true", "command": "ModifyGridSecurity" } }
Command Type:  grid
 
 
GrantGroupAccess
Description:  Gives a group access rights to a data grid.
Required Parameters: 
gridName   Specifies the name of the data grid to grant 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.
groupName   Specifies the name of the group to grant the given access rights.
Result Parameters: 
status   Specifies the status of the command that was run. The result can be either success or failed.
commandName   Specifies the name of the HTTP command interface command that was run.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
errorMessage   A message that explains the reason for the failure, if the command failed.
Example:  { "task": { "gridName": "myGrid", "stopOnTaskFailure": "true", "groupName": "somegroup", "command": "GrantGroupAccess" } }
Command Type:  grid
 
 
ModifyGroupAccess
Description:  Changes the group access rights for a data grid.
Required Parameters: 
gridName   Specifies the name of the data grid to update.
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.
groupName   Specifies the name of the group for which you want to modify access rights.
accessType   Specifies the type of access to give to the group. Valid values: 1 = read, 2 = write, 3 = create, 4 = all.
Result Parameters: 
status   Specifies the status of the command that was run. The result can be either success or failed.
commandName   Specifies the name of the HTTP command interface command that was run.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
errorMessage   A message that explains the reason for the failure, if the command failed.
Example:  { "task": { "gridName": "myGrid", "stopOnTaskFailure": "true", "groupName": "somegroup", "command": "ModifyGroupAccess", "accessType": "1" } }
Command Type:  grid
 
 
ClearGrid
Description:  Clears data from a data grid.
Required Parameters: 
gridName   Specifies the name of the data grid to be cleared.
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: 
status   Specifies the status of the command that was run. The result can be either success or failed.
commandName   Specifies the name of the HTTP command interface command that was run.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
errorMessage   A message that explains the reason for the failure, if the command failed.
Example:  { "task": { "gridName": "myGrid", "stopOnTaskFailure": "true", "command": "ClearGrid" } }
Command Type:  grid
 
 
ViewGrid
Description:  Displays information for a data grid.
Required Parameters: 
gridName   Specifies the name of the data grid to be viewed.
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: 
status   Specifies the status of the command that was run. The result can be either success or failed.
commandName   Specifies the name of the HTTP command interface command that was run.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
errorMessage   A message that explains the reason for the failure, if the command failed.
Example:  { "task": { "gridName": "myGrid", "stopOnTaskFailure": "true", "command": "ViewGrid" } }
Command Type:  grid
 
 
GrantUserAccess
Description:  Gives a user access rights to a data grid.
Required Parameters: 
gridName   Specifies the name of the data grid to which the user is assigned access.
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 the user to give access rights.
Result Parameters: 
status   Specifies the status of the command that was run. The result can be either success or failed.
commandName   Specifies the name of the HTTP command interface command that was run.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
errorMessage   A message that explains the reason for the failure, if the command failed.
Example:  { "task": { "gridName": "myGrid", "stopOnTaskFailure": "true", "userName": "someuser", "command": "GrantUserAccess" } }
Command Type:  grid
 
 
ExportGrid
Description:  (Simple data grids only) Exports data grid information to XML.
Required Parameters: 
gridName   Specifies the name of the data grid to export.
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: 
status   Specifies the status of the command that was run. The result can be either success or failed.
commandName   Specifies the name of the HTTP command interface command that was run.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
errorMessage   A message that explains the reason for the failure, if the command failed.
Example:  { "task": { "gridName": "myGrid", "stopOnTaskFailure": "true", "command": "ExportGrid" } }
Command Type:  grid
 
 
RemoveGroupAccess
Description:  Removes the access rights for a group to a data grid.
Required Parameters: 
gridName   Specifies the name of the data grid to update.
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.
groupName   Specifies the name of the group for which to remove access rights.
Result Parameters: 
status   Specifies the status of the command that was run. The result can be either success or failed.
commandName   Specifies the name of the HTTP command interface command that was run.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
errorMessage   A message that explains the reason for the failure, if the command failed.
Example:  { "task": { "gridName": "myGrid", "stopOnTaskFailure": "true", "groupName": "Everyone", "command": "RemoveGroupAccess" } }
Command Type:  grid
 
 
DeleteGrid
Description:  Deletes a data grid.
Required Parameters: 
gridName   Specifies the name of the data grid to delete.
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: 
status   Specifies the status of the command that was run. The result can be either success or failed.
commandName   Specifies the name of the HTTP command interface command that was run.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
errorMessage   A message that explains the reason for the failure, if the command failed.
Example:  { "task": { "gridName": "myGrid", "stopOnTaskFailure": "true", "command": "DeleteGrid" } }
Command Type:  grid
 
 
ModifyGridTTL
Description:  (Simple data grids only) Changes time to live (TTL) settings for the data grid.
Required Parameters: 
gridName   Specifies the name of the data grid to update.
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.
gridTTL   Specifies the amount of time, in seconds, to keep data before evicting the data from 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.
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.
Result Parameters: 
status   Specifies the status of the command that was run. The result can be either success or failed.
commandName   Specifies the name of the HTTP command interface command that was run.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
errorMessage   A message that explains the reason for the failure, if the command failed.
Example:  { "task": { "gridName": "myGrid", "stopOnTaskFailure": "true", "gridTTL": "60000", "waitOnTask": "true", "defaultMapEvictorType": "CREATION_TIME", "command": "ModifyGridTTL" } }
Command Type:  grid
 
 
ViewAllGrids
Description:  Displays information for all simple, dynamic cache, or session grids.
Required Parameters: 
gridType   Specifies the type of data grid to display. The types include: simple, dynamic, or session.
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: 
status   Specifies the status of the command that was run. The result can be either success or failed.
commandName   Specifies the name of the HTTP command interface command that was run.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
errorMessage   A message that explains the reason for the failure, if the command failed.
Example:  { "task": { "gridType": "simple", "stopOnTaskFailure": "true", "command": "ViewAllGrids" } }
Command Type:  grid
 
 
RemoveUserAccess
Description:  Removes access rights to a data grid for a specified user.
Required Parameters: 
gridName   Specifies the name of the data grid to update.
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 the user for which you are removing access rights.
Result Parameters: 
status   Specifies the status of the command that was run. The result can be either success or failed.
commandName   Specifies the name of the HTTP command interface command that was run.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
errorMessage   A message that explains the reason for the failure, if the command failed.
Example:  { "task": { "gridName": "myGrid", "stopOnTaskFailure": "true", "userName": "someuser", "command": "RemoveUserAccess" } }
Command Type:  grid
 
 
ModifyUserAccess
Description:  Changes user access rights for a data grid.
Required Parameters: 
gridName   Specifies the name of the data grid to update.
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 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: 
status   Specifies the status of the command that was run. The result can be either success or failed.
commandName   Specifies the name of the HTTP command interface command that was run.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
errorMessage   A message that explains the reason for the failure, if the command failed.
Example:  { "task": { "gridName": "myGrid", "stopOnTaskFailure": "true", "userName": "someuser", "command": "ModifyUserAccess", "accessType": "1" } }
Command Type:  grid
 
 
ModifyGridCapacity
Description:  Changes the capacity for a simple data grid.
Required Parameters: 
gridName   Specifies the name of the data grid to update.
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.
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: 
status   Specifies the status of the command that was run. The result can be either success or failed.
commandName   Specifies the name of the HTTP command interface command that was run.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
errorMessage   A message that explains the reason for the failure, if the command failed.
Example:  { "task": { "gridName": "myGrid", "stopOnTaskFailure": "true", "useLRU": "false", "waitOnTask": "true", "command": "ModifyGridCapacity", "gridCapLimit": "10" } }
Command Type:  grid
 
 
ModifyGridReplication
Description:  Changes the replication settings for a data grid.
Required Parameters: 
gridName   Specifies the name of the data grid to update.
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.
maximumSyncReplicas   Specifies the maximum number of synchronous replicas for this data grid.
maximumAsyncReplicas   Specifies the maximum number of asynchronous 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.
Result Parameters: 
status   Specifies the status of the command that was run. The result can be either success or failed.
commandName   Specifies the name of the HTTP command interface command that was run.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
errorMessage   A message that explains the reason for the failure, if the command failed.
Example:  { "task": { "gridName": "myGrid", "stopOnTaskFailure": "true", "maximumSyncReplicas": "4", "maximumAsyncReplicas": "2", "waitOnTask": "true", "command": "ModifyGridReplication" } }
Command Type:  grid
 
 
ViewGridAccessList
Description:  Displays the list of users and groups that can access the specified data grid.
Required Parameters: 
gridName   Specifies the name of the data grid to which access list is retrieved.
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: 
status   Specifies the status of the command that was run. The result can be either success or failed.
commandName   Specifies the name of the HTTP command interface command that was run.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
errorMessage   A message that explains the reason for the failure, if the command failed.
Example:  { "task": { "gridName": "myGrid", "stopOnTaskFailure": "true", "command": "ViewGridAccessList" } }
Command Type:  grid
 
 
CreateGrid
Description:  Creates a new simple, dynamic cache, or session data grid.
Required Parameters: 
gridType   Specifies the type of data grid to create. Valid values: simple, dynamic, or session.
gridName   Specifies the name of the data grid to create.
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: 
status   Specifies the status of the command that was run. The result can be either success or failed.
commandName   Specifies the name of the HTTP command interface command that was run.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
errorMessage   A message that explains the reason for the failure, if the command failed.
Example:  { "task": { "gridType": "simple", "gridName": "myGrid", "stopOnTaskFailure": "true", "waitOnTask": "true", "command": "CreateGrid" } }
Command Type:  grid
 
 

List of TASK commands

 
ViewTask
Description:  Displays a task.
Required Parameters: 
taskId   Specifies the Task ID.
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: 
status   Specifies the status of the command that was run. The result can be either success or failed.
commandName   Specifies the name of the HTTP command interface command that was run.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
errorMessage   A message that explains the reason for the failure, if the command failed.
Example:  { "task": { "taskId": "appliance_10003", "stopOnTaskFailure": "true", "command": "ViewTask" } }
Command Type:  task
 
 
DeleteTask
Description:  Deletes a task.
Required Parameters: 
taskId   Specifies the ID of task to delete.
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: 
status   Specifies the status of the command that was run. The result can be either success or failed.
commandName   Specifies the name of the HTTP command interface command that was run.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
errorMessage   A message that explains the reason for the failure, if the command failed.
Example:  { "task": { "taskId": "appliance_10003", "stopOnTaskFailure": "true", "command": "DeleteTask" } }
Command Type:  task
 
 
ViewAllTasks
Description:  Displays all tasks.
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: 
status   Specifies the status of the command that was run. The result can be either success or failed.
commandName   Specifies the name of the HTTP command interface command that was run.
commandResult   A JSON-formatted statement that contains the result of the command that was run.
errorMessage   A message that explains the reason for the failure, if the command failed.
Example:  { "task": { "stopOnTaskFailure": "true", "command": "ViewAllTasks" } }
Command Type:  task