diff --git a/docs/source/advanced/restapi/restapi_resource/restapi_reference.rst b/docs/source/advanced/restapi/restapi_resource/restapi_reference.rst index 42c849d72..92f6018cd 100644 --- a/docs/source/advanced/restapi/restapi_resource/restapi_reference.rst +++ b/docs/source/advanced/restapi/restapi_resource/restapi_reference.rst @@ -71,7 +71,7 @@ Refer to the man page: :doc:`lsdef : {att:value, attr:value ...}' pairs. +* Json format: An object which includes multiple ' : {attr:value, attr:value ...}' pairs. **Example:** @@ -97,11 +97,11 @@ Refer to the man page: :doc:`chdef : {att:value, attr:value ...}' pairs. +* Json format: An object which includes multiple ' : {attr:value, attr:value ...}' pairs. **Example:** @@ -181,7 +181,7 @@ Refer to the man page: :doc:`makehosts : {att:value, attr:value ...}' pairs. +* Json format: An object which includes multiple ' : {attr:value, attr:value ...}' pairs. **Example:** @@ -377,7 +377,7 @@ Refer to the man page: :doc:`rpower : {att:value, attr:value ...}' pairs. +* Json format: An object which includes multiple ' : {attr:value, attr:value ...}' pairs. **Example:** @@ -418,11 +418,11 @@ Refer to the man page: :doc:`renergy : {att:value, attr:value ...}' pairs. +* Json format: An object which includes multiple ' : {attr:value, attr:value ...}' pairs. **Example:** @@ -465,7 +465,7 @@ Refer to the man page: :doc:`rspconfig : {att:value, attr:value ...}' pairs. +* Json format: An object which includes multiple ' : {attr:value, attr:value ...}' pairs. **Example:** @@ -486,11 +486,11 @@ Refer to the man page: :doc:`rspconfig : {att:value, attr:value ...}' pairs. +* Json format: An object which includes multiple ' : {attr:value, attr:value ...}' pairs. **Example:** @@ -529,11 +529,11 @@ Refer to the man page: :doc:`rsetboot : {att:value, attr:value ...}' pairs. +* Json format: An object which includes multiple ' : {attr:value, attr:value ...}' pairs. **Example:** @@ -572,11 +572,11 @@ Refer to the man page: :doc:`nodeset : {att:value, attr:value ...}' pairs. +* Json format: An object which includes multiple ' : {attr:value, attr:value ...}' pairs. **Example:** -Get all the vitails attributes for the node1. :: +Get all the vitals attributes for the node1. :: curl -X GET -k 'https://127.0.0.1/xcatws/nodes/node1/vitals?userName=root&userPW=cluster&pretty=1' @@ -625,7 +625,7 @@ Refer to the man page: :doc:`rvitals : {att:value, attr:value ...}' pairs. +* Json format: An object which includes multiple ' : {attr:value, attr:value ...}' pairs. **Example:** @@ -656,7 +656,7 @@ Refer to the man page: :doc:`rinv ` **Returns:** -* Json format: An object which includes multiple ' : {att:value, attr:value ...}' pairs. +* Json format: An object which includes multiple ' : {attr:value, attr:value ...}' pairs. **Example:** @@ -687,7 +687,7 @@ Refer to the man page: :doc:`rinv ` **Returns:** -* Json format: An object which includes multiple ' : {att:value, attr:value ...}' pairs. +* Json format: An object which includes multiple ' : {attr:value, attr:value ...}' pairs. **Example:** @@ -712,7 +712,7 @@ Refer to the man page: :doc:`reventlog : {att:value, attr:value ...}' pairs. +* Json format: An object which includes multiple ' : {attr:value, attr:value ...}' pairs. **Example:** @@ -735,7 +735,7 @@ Refer to the man page: :doc:`reventlog : {att:value, attr:value ...}' pairs. +* Json format: An object which includes multiple ' : {attr:value, attr:value ...}' pairs. **Example:** @@ -785,11 +785,11 @@ Refer to the man page: :doc:`rbeacon : {att:value, attr:value ...}' pairs. +* Json format: An object which includes multiple ' : {attr:value, attr:value ...}' pairs. **Example:** @@ -885,11 +885,11 @@ Refer to the man page: :doc:`updatenode : {att:value, attr:value ...}' pairs. +* Json format: An object which includes multiple ' : {attr:value, attr:value ...}' pairs. **Example:** @@ -921,11 +921,11 @@ Refer to the man page: :doc:`xdsh ` **Parameters:** -* Json format: An object which includes multiple 'att:value' pairs. DataBody: set environment {ENV:{en1:v1,en2:v2}}, raw command {raw:[op1,op2]}, direct command {command:[cmd1,cmd2]}. +* Json format: An object which includes multiple 'attr:value' pairs. DataBody: set environment {ENV:{en1:v1,en2:v2}}, raw command {raw:[op1,op2]}, direct command {command:[cmd1,cmd2]}. **Returns:** -* Json format: An object which includes multiple ' : {att:value, attr:value ...}' pairs. +* Json format: An object which includes multiple ' : {attr:value, attr:value ...}' pairs. **Example:** @@ -951,11 +951,11 @@ Refer to the man page: :doc:`xdcp ` **Parameters:** -* Json format: An object which includes multiple 'att:value' pairs. DataBody: {src:[file1,file2],target:dir}. +* Json format: An object which includes multiple 'attr:value' pairs. DataBody: {src:[file1,file2],target:dir}. **Returns:** -* No output when execution is successful. Otherwise output the error information in the Standard Error Format: {error:[msg1,msg2...],errocode:errornum}. +* No output when execution is successful. Otherwise output the error information in the Standard Error Format: {error:[msg1,msg2...],errorcode:errornum}. **Example:** @@ -977,14 +977,14 @@ Refer to the man page: :doc:`chvm ` **Parameters:** -* Json format: An object which includes multiple 'att:value' pairs. DataBody: +* Json format: An object which includes multiple 'attr:value' pairs. DataBody: Set memory size - {"memorysize":"sizeofmemory(MB)"} Add new disk - {"adddisk":"sizeofdisk1(GB),sizeofdisk2(GB)"} Purge disk - {"purgedisk":"scsi_id1,scsi_id2"} **Returns:** -* No output when execution is successful. Otherwise output the error information in the Standard Error Format: {error:[msg1,msg2...],errocode:errornum}. +* No output when execution is successful. Otherwise output the error information in the Standard Error Format: {error:[msg1,msg2...],errorcode:errornum}. **Example1:** @@ -1011,7 +1011,7 @@ Refer to the man page: :doc:`mkvm ` **Parameters:** -* Json format: An object which includes multiple 'att:value' pairs. DataBody: +* Json format: An object which includes multiple 'attr:value' pairs. DataBody: Set CPU count - {"cpucount":"numberofcpu"} Set memory size - {"memorysize":"sizeofmemory(MB)"} Set disk size - {"disksize":"sizeofdisk"} @@ -1019,7 +1019,7 @@ Refer to the man page: :doc:`mkvm ` **Returns:** -* No output when execution is successful. Otherwise output the error information in the Standard Error Format: {error:[msg1,msg2...],errocode:errornum}. +* No output when execution is successful. Otherwise output the error information in the Standard Error Format: {error:[msg1,msg2...],errorcode:errornum}. **Example:** @@ -1034,13 +1034,13 @@ Refer to the man page: :doc:`rmvm ` **Parameters:** -* Json format: An object which includes multiple 'att:value' pairs. DataBody: +* Json format: An object which includes multiple 'attr:value' pairs. DataBody: Purge disk - {"purge":"yes"} Do it by force - {"force":"yes"} **Returns:** -* No output when execution is successful. Otherwise output the error information in the Standard Error Format: {error:[msg1,msg2...],errocode:errornum}. +* No output when execution is successful. Otherwise output the error information in the Standard Error Format: {error:[msg1,msg2...],errorcode:errornum}. **Example:** @@ -1060,7 +1060,7 @@ Refer to the man page: :doc:`clonevm : {att:value, attr:value ...}' pairs. +* Json format: An object which includes multiple ' : {attr:value, attr:value ...}' pairs. **Example:** @@ -1206,15 +1206,15 @@ Refer to the man page: :doc:`chdef ` **Parameters:** -* Json format: An object which includes multiple 'att:value' pairs. DataBody: {action:gen\pack\export,params:[{attr1:value1,attr2:value2...}]} +* Json format: An object which includes multiple 'attr:value' pairs. DataBody: {action:gen\pack\export,params:[{attr1:value1,attr2:value2...}]} **Returns:** -* No output when execution is successful. Otherwise output the error information in the Standard Error Format: {error:[msg1,msg2...],errocode:errornum}. +* No output when execution is successful. Otherwise output the error information in the Standard Error Format: {error:[msg1,msg2...],errorcode:errornum}. **Example1:** @@ -1322,7 +1322,7 @@ Refer to the man page: :doc:`rmimage : {att:value, attr:value ...}' pairs. +* Json format: An object which includes multiple ' : {attr:value, attr:value ...}' pairs. **Example:** @@ -1420,11 +1420,11 @@ Refer to the man page: :doc:`chdef ` **Parameters:** -* Json format: An object which includes multiple 'att:value' pairs. DataBody: {attr1:v1,att2:v2,...}. +* Json format: An object which includes multiple 'attr:value' pairs. DataBody: {attr1:v1,attr2:v2,...}. **Returns:** -* No output when execution is successful. Otherwise output the error information in the Standard Error Format: {error:[msg1,msg2...],errocode:errornum}. +* No output when execution is successful. Otherwise output the error information in the Standard Error Format: {error:[msg1,msg2...],errorcode:errornum}. **Example:** @@ -1458,7 +1458,7 @@ Refer to the man page: :doc:`rmdef : {att:value, attr:value ...}' pairs. +* Json format: An object which includes multiple ' : {attr:value, attr:value ...}' pairs. **Example:** @@ -1504,13 +1504,13 @@ The URI list which can be used to create, query, change and manage policy entrie GET - Get all the policies in xCAT. ``````````````````````````````````` -It will dislplay all the policy resource. +It will display all the policy resource. Refer to the man page: :doc:`lsdef ` **Returns:** -* Json format: An object which includes multiple ' : {att:value, attr:value ...}' pairs. +* Json format: An object which includes multiple ' : {attr:value, attr:value ...}' pairs. **Example:** @@ -1539,7 +1539,7 @@ Refer to the man page: :doc:`lsdef : {att:value, attr:value ...}' pairs. +* Json format: An object which includes multiple ' : {attr:value, attr:value ...}' pairs. **Example:** @@ -1563,11 +1563,11 @@ Refer to the man page: :doc:`chdef ` **Parameters:** -* Json format: An object which includes multiple 'att:value' pairs. DataBody: {attr1:v1,att2:v2,...}. +* Json format: An object which includes multiple 'attr:value' pairs. DataBody: {attr1:v1,attr2:v2,...}. **Returns:** -* No output when execution is successful. Otherwise output the error information in the Standard Error Format: {error:[msg1,msg2...],errocode:errornum}. +* No output when execution is successful. Otherwise output the error information in the Standard Error Format: {error:[msg1,msg2...],errorcode:errornum}. **Example:** @@ -1605,7 +1605,7 @@ Refer to the man page: :doc:`rmdef : {att:value, attr:value ...}' pairs. +* Json format: An object which includes multiple ' : {attr:value, attr:value ...}' pairs. **Example:** @@ -1687,7 +1687,7 @@ Refer to the man page: :doc:`lsdef : {att:value, attr:value ...}' pairs. +* Json format: An object which includes multiple ' : {attr:value, attr:value ...}' pairs. **Example:** @@ -1708,11 +1708,11 @@ Refer to the man page: :doc:`chdef : {att:value, attr:value ...}' pairs. +* Json format: An object which includes multiple ' : {attr:value, attr:value ...}' pairs. **Example:** @@ -1764,7 +1764,7 @@ Refer to the man page: :doc:`lsdef : {att:value, attr:value ...}' pairs. +* Json format: An object which includes multiple ' : {attr:value, attr:value ...}' pairs. **Example:** @@ -1792,7 +1792,7 @@ Refer to the man page: :doc:`lsdef : {att:value, attr:value ...}' pairs. +* Json format: An object which includes multiple ' : {attr:value, attr:value ...}' pairs. **Example:** @@ -1816,11 +1816,11 @@ Refer to the man page: :doc:`chdef ` **Returns:** -* No output when execution is successful. Otherwise output the error information in the Standard Error Format: {error:[msg1,msg2...],errocode:errornum}. +* No output when execution is successful. Otherwise output the error information in the Standard Error Format: {error:[msg1,msg2...],errorcode:errornum}. **Example:** @@ -1860,7 +1860,7 @@ Refer to the man page: :doc:`makedns : {att:value, attr:value ...}' pairs. +* Json format: An object which includes multiple ' : {attr:value, attr:value ...}' pairs. **Example:** @@ -1950,7 +1950,7 @@ Refer to the man page: :doc:`lsslp : {att:value, attr:value ...}' pairs. +* Json format: An object which includes multiple ' : {attr:value, attr:value ...}' pairs. **Example:** @@ -2075,11 +2075,11 @@ PUT - Change the node table attributes for {noderange}. **Parameters:** -* A hash of table names and attribute objects. DataBody: {table1:{attr1:v1,att2:v2,...}}. +* A hash of table names and attribute objects. DataBody: {table1:{attr1:v1,attr2:v2,...}}. **Returns:** -* No output when execution is successful. Otherwise output the error information in the Standard Error Format: {error:[msg1,msg2...],errocode:errornum}. +* No output when execution is successful. Otherwise output the error information in the Standard Error Format: {error:[msg1,msg2...],errorcode:errornum}. **Example:** @@ -2196,11 +2196,11 @@ PUT - Change the non-node table attributes for the row that matches the {keys}. **Parameters:** -* A hash of attribute names and values. DataBody: {attr1:v1,att2:v2,...}. +* A hash of attribute names and values. DataBody: {attr1:v1,attr2:v2,...}. **Returns:** -* No output when execution is successful. Otherwise output the error information in the Standard Error Format: {error:[msg1,msg2...],errocode:errornum}. +* No output when execution is successful. Otherwise output the error information in the Standard Error Format: {error:[msg1,msg2...],errorcode:errornum}. **Example:** @@ -2213,7 +2213,7 @@ DELETE - Delete rows from a non-node table that have the attribute values specif **Returns:** -* No output when execution is successful. Otherwise output the error information in the Standard Error Format: {error:[msg1,msg2...],errocode:errornum}. +* No output when execution is successful. Otherwise output the error information in the Standard Error Format: {error:[msg1,msg2...],errorcode:errornum}. **Example:** diff --git a/docs/source/advanced/restapi/restapi_setup/restapi_setup.rst b/docs/source/advanced/restapi/restapi_setup/restapi_setup.rst index 73b452a42..5b9470bf2 100644 --- a/docs/source/advanced/restapi/restapi_setup/restapi_setup.rst +++ b/docs/source/advanced/restapi/restapi_setup/restapi_setup.rst @@ -86,7 +86,7 @@ Set Up an Account for Web Service Access User needs a username and password to access the REST API. When the REST API request is passed to xcatd, the username and password will be verified based on the :doc:`xCAT passwd Table `, and then xcatd will look in the :doc:`xCAT policy Table ` to see if the user is allowed to perform the requested operation. -The account with key of **xcat** will be used for the REST API authentication. The username and password should be passed in as the attirbutes of URL: +The account with key of **xcat** will be used for the REST API authentication. The username and password should be passed in as the attributes of URL: :userName: Pass the username of the account :userPW: Pass the password of the account (xCAT 2.10)