2
0
mirror of https://github.com/xcat2/xcat-core.git synced 2025-05-22 03:32:04 +00:00

Fix errors/warnings in the documentation during the build

This commit is contained in:
Victor Hu 2016-03-01 17:31:18 -05:00
parent af70f44c7f
commit d75ecae303
4 changed files with 139 additions and 112 deletions

View File

@ -141,28 +141,27 @@ The **domain** and **nameservers** values must be set correctly in **/etc/resolv
* Add the TSIG to the named.conf of your external dns for makedns command to update external dns ::
tabdump -w key==omapi passwd
get the key like "omapi","xcat_key","MFRCeHJybnJxeVBNaE1YT1BFTFJzN2JuREFMeEMwU0U=",,,,
Add it to your named.conf
key xcat_key {
algorithm hmac-md5;
secret "MFRCeHJybnJxeVBNaE1YT1BFTFJzN2JuREFMeEMwU0U=";
};
tabdump -w key==omapi passwd
get the key like "omapi","xcat_key","MFRCeHJybnJxeVBNaE1YT1BFTFJzN2JuREFMeEMwU0U=",,,,
Add it to your named.conf
key xcat_key {
algorithm hmac-md5;
secret "MFRCeHJybnJxeVBNaE1YT1BFTFJzN2JuREFMeEMwU0U=";
};
* Then change each zone to make your zones to allow this key to update.
zone "1.168.192.IN-ADDR.ARPA." in {
type master;
allow-update {
key xcat_key;
};
file "db.192.168.1";
};
* Then change each zone to make your zones to allow this key to update. ::
* To update the name resolution entries from /etc/hosts or hosts table of xCAT MN to external dns
zone "1.168.192.IN-ADDR.ARPA." in {
type master;
allow-update {
key xcat_key;
};
file "db.192.168.1";
};
``makedns -e``
* To update the name resolution entries from ``/etc/hosts`` or hosts table of xCAT MN to external DNS, run ``makedns -e``
Alternatively, you can set site.externaldns=1 and run ``makedns``
Alternatively, you can set site.externaldns=1 and run ``makedns``
Option #3: Run DNS on Management Node and Service Nodes
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

View File

@ -8,18 +8,16 @@ Configuration for Diskless Installation
cp /opt/xcat/share/xcat/netboot/<ostype>/compute.<osver>.<arch>.pkglist \
/install/custom/netboot/<ostype>/compute.<osver>.<arch>.pkglist
b) Edit your ``/install/custom/netboot/<ostype>/<profile>.pkglist`` and add below line
``#INCLUDE:/opt/xcat/share/xcat/ib/netboot/<ostype>/ib.<osver>.<arch>.pkglist#``
b) Edit ``/install/custom/netboot/<ostype>/<profile>.pkglist`` and add ``#INCLUDE:/opt/xcat/share/xcat/ib/netboot/<ostype>/ib.<osver>.<arch>.pkglist#``
Take RHEL 6.4 on x86_64 for example ::
For example, on RHEL 6.4 (x86_64): ::
cp /opt/xcat/share/xcat/netboot/rh/compute.rhels6.x86_64.pkglist \
/install/custom/netboot/rh/compute.rhels6.x86_64.pkglist
Edit the ``/install/custom/netboot/rh/compute.rhels6.x86_64.pkglist`` and add below line
``#INCLUDE:/opt/xcat/share/xcat/ib/netboot/rh/ib.rhels6.x86_64.pkglist#``
Edit ``/install/custom/netboot/rh/compute.rhels6.x86_64.pkglist`` and add ``#INCLUDE:/opt/xcat/share/xcat/ib/netboot/rh/ib.rhels6.x86_64.pkglist#``
Then ``/install/custom/netboot/rh/compute.rhels6.x86_64.pkglist`` looks like below ::
Then ``/install/custom/netboot/rh/compute.rhels6.x86_64.pkglist`` looks like below ::
#INCLUDE:/opt/xcat/share/xcat/ib/netboot/rh/ib.rhels6.x86_64.pkglist#
bash

View File

@ -101,112 +101,148 @@ xCAT Port Usage Table
+--------------+-------------+-------------+------------+----------------------------------------+
* xcatdport
The port used by the xcatd daemon for client/server communication.
The port used by the xcatd daemon for client/server communication.
* xcatiport
The port used by xcatd to receive install status updates from nodes.
The port used by xcatd to receive install status updates from nodes.
* xcatlport
The port used by xcatd to record command log, you can customize it by edit site table, if you don't configure it, 3003 will be used by default.
The port used by xcatd to record command log, you can customize it by edit site table, if you don't configure it, 3003 will be used by default.
* echo-udp
Needed by RSCT Topology Services.
Needed by RSCT Topology Services.
* ssh-udp
Needed to use ssh. This service defines the protocol for upd. This is required when installing or running updatenode, xdsh,xdcp,psh,pcp through the firewall.
Needed to use ssh. This service defines the protocol for upd. This is required when installing or running updatenode, xdsh,xdcp,psh,pcp through the firewall.
* rsync
Need to use updatenode or xdcp to rsync files to the nodes or service nodes.
Need to use updatenode or xdcp to rsync files to the nodes or service nodes.
* domain-tcp
Used when Domain Name Services (DNS) traffic from the Non-trusted nodes and the firewall node to a DNS server is explicitly handled by the firewall. Some firewall applications can be configured to explicitly handle all DNS traffic. This for tcp DNS traffic.
Used when Domain Name Services (DNS) traffic from the Non-trusted nodes and the firewall node to a DNS server is explicitly handled by the firewall. Some firewall applications can be configured to explicitly handle all DNS traffic. This for tcp DNS traffic.
* domain-udp
Used when Domain Name Services (DNS) traffic from the Non-trusted nodes and the firewall node to a DNS server is explicitly handled by the firewall. Some firewall applications can be configured to explicitly handle all DNS traffic. This for udp DNS traffic.
Used when Domain Name Services (DNS) traffic from the Non-trusted nodes and the firewall node to a DNS server is explicitly handled by the firewall. Some firewall applications can be configured to explicitly handle all DNS traffic. This for udp DNS traffic.
* bootps
Bootp server port needed when installing an Non-trusted AIX or System p node through the firewall. This service is issued by the client to the Management Node , for an install request. It is not required to install the Non-trusted nodes through the firewall or to apply maintenance. This is the reason why the service is considered optional.
Bootp server port needed when installing an Non-trusted AIX or System p node through the firewall. This service is issued by the client to the Management Node , for an install request. It is not required to install the Non-trusted nodes through the firewall or to apply maintenance. This is the reason why the service is considered optional.
* dhcp
Needed to install Linux nodes through the firewall. This is the port for the dhcp server. This service defines the protocol for tcp.
Needed to install Linux nodes through the firewall. This is the port for the dhcp server. This service defines the protocol for tcp.
* dhcpc
Needed to install Linux through the firewall. This is the port for the dhcp client. This service defines the protocol for tcp.
Needed to install Linux through the firewall. This is the port for the dhcp client. This service defines the protocol for tcp.
* bootpc
Bootp client port needed when installing an Non-trusted AIX or System p node through the firewall. This service is issued by the Management Node back to the client, in response to an install request from the client. It is not required to install the Non-trusted nodes through the firewall or to apply maintenance. This is the reason why the service is considered optional.
Bootp client port needed when installing an Non-trusted AIX or System p node through the firewall. This service is issued by the Management Node back to the client, in response to an install request from the client. It is not required to install the Non-trusted nodes through the firewall or to apply maintenance. This is the reason why the service is considered optional.
* tftp-tcp
Needed to install Linux nodes. This service defines the protocol for tcp.
Needed to install Linux nodes. This service defines the protocol for tcp.
* tftp-udp
Needed to install Linux nodes. This service defines the protocol for udp.
Needed to install Linux nodes. This service defines the protocol for udp.
* www-tcp
Needed to use World Wide Web http.This service defines the protocol for tcp.
Needed to use World Wide Web http.This service defines the protocol for tcp.
* www-udp
Needed to use World Wide Web http. This service defines the protocol for udp.
Needed to use World Wide Web http. This service defines the protocol for udp.
* kerberos
Kerberos Version 5 KDC. Needed if running Kerberos Version 5 remote command authentication. This service defines the protocol for tcp.
Kerberos Version 5 KDC. Needed if running Kerberos Version 5 remote command authentication. This service defines the protocol for tcp.
* kerberos
Kerberos Version 5 KDC. Needed if running Kerberos Version 5 remote command authentication. This service defines the protocol for udp.
Kerberos Version 5 KDC. Needed if running Kerberos Version 5 remote command authentication. This service defines the protocol for udp.
* sunrpc-udp
The portmapper service. Needed when installing a Non-trusted node through the firewall. Specifically required mount request that takes place during node install.
The portmapper service. Needed when installing a Non-trusted node through the firewall. Specifically required mount request that takes place during node install.
* shell
Used when rsh/rcp is enabled for Standard (std) authentication protocol. Needed for xdsh operations when using rsh for remote commands.
Used when rsh/rcp is enabled for Standard (std) authentication protocol. Needed for xdsh operations when using rsh for remote commands.
* rsyslogd
Used for system log monitoring. This is for tcp protocol.
Used for system log monitoring. This is for tcp protocol.
* rsyslogd
Used for system log monitoring. This is for udp protocol.
Used for system log monitoring. This is for udp protocol.
* kshell
Used rsh/rcp is enabled for Kerberos authentication. Not currently supported in xCAT. Network Installation Management client traffic generated by an Non-trusted node during node boot/shutdown. Required if using NIM. AIX only.
Used rsh/rcp is enabled for Kerberos authentication. Not currently supported in xCAT. Network Installation Management client traffic generated by an Non-trusted node during node boot/shutdown. Required if using NIM. AIX only.
* rmc-tcp
Resource Monitoring and Control (RMC) used for hardware monitoring, key exchange. This is for tcp protocol.
Resource Monitoring and Control (RMC) used for hardware monitoring, key exchange. This is for tcp protocol.
* rmc-udp
Resource Monitoring and Control (RMC) used for hardware monitoring, key exchange. This is for udp protocol.
Resource Monitoring and Control (RMC) used for hardware monitoring, key exchange. This is for udp protocol.
* conserver
Required on the xCAT management node and service nodes. This service defines the protocol for tcp.
Required on the xCAT management node and service nodes. This service defines the protocol for tcp.
* nfsd-tcp
Needed to use the AIX mount command. This service defines the protocol for tcp. Required when installing an Non-trusted node through the firewall. Needed when an installp is issued on an Non-trusted node and the resource exists on the Trusted side.
Needed to use the AIX mount command. This service defines the protocol for tcp. Required when installing an Non-trusted node through the firewall. Needed when an installp is issued on an Non-trusted node and the resource exists on the Trusted side.
* nfsd-udp
Needed to use the AIX mount command. This service defines the protocol for udp. Required when installing an Non-trusted node through the firewall.
Needed to use the AIX mount command. This service defines the protocol for udp. Required when installing an Non-trusted node through the firewall.
* pxe
Needed to install System x nodes through the firewall. This is the port for the PXE boot server. This service defines the protocol for tcp.
Needed to install System x nodes through the firewall. This is the port for the PXE boot server. This service defines the protocol for tcp.
* rpc-mount
Remote Procedure Call (RPM) used in conjunction with NFS mount request. See note 2. ssh-tcp Needed to use ssh. This service defines the protocol for tcp. This is required when installing or running updatenode through the firewall.
Remote Procedure Call (RPM) used in conjunction with NFS mount request. See note 2. ssh-tcp Needed to use ssh. This service defines the protocol for tcp. This is required when installing or running updatenode through the firewall.
* mount-tcp
Needed to use the AIX mount command. This service defines the protocol for tcp. Required when installing an Non-trusted node through the firewall. Needed when installp is issued on an Non-trusted node and the resource exists on the Trusted side. Needed to run updatenode command. See note 1.
Needed to use the AIX mount command. This service defines the protocol for tcp. Required when installing an Non-trusted node through the firewall. Needed when installp is issued on an Non-trusted node and the resource exists on the Trusted side. Needed to run updatenode command. See note 1.
* mount-udp
Needed to use the AIX mount command. This service defines the protocol for udp. Needed when installp is issued on an Non-trusted node and the resource exists on the Trusted side. Needed to run updatenode command. See note 1.
Needed to use the AIX mount command. This service defines the protocol for udp. Needed when installp is issued on an Non-trusted node and the resource exists on the Trusted side. Needed to run updatenode command. See note 1.
* awk
For awk communication during node discovery.
For awk communication during node discovery.
* impi
For ipmi traffic.
For ipmi traffic.
* snmp
For SNMP communication to blade chassis.
For SNMP communication to blade chassis.
* snmptrap
For SNMP communication to blade chassis.
For SNMP communication to blade chassis.
Note 1 - AIX mount
``````````````````

View File

@ -109,6 +109,8 @@ Change the attributes mgt=dfm and netboot=yaboot. ::
#curl -X PUT -k 'https://127.0.0.1/xcatws/nodes/node1?userName=root&userPW=cluster&pretty=1' -H Content-Type:application/json --data '{"mgt":"dfm","netboot":"yaboot"}'
POST - Create the node {noderange}.
```````````````````````````````````
@ -128,6 +130,7 @@ Create a node with attributes groups=all, mgt=dfm and netboot=yaboot ::
#curl -X POST -k 'https://127.0.0.1/xcatws/nodes/node1?userName=root&userPW=cluster&pretty=1' -H Content-Type:application/json --data '{"groups":"all","mgt":"dfm","netboot":"yaboot"}'
DELETE - Remove the node {noderange}.
`````````````````````````````````````
@ -141,8 +144,8 @@ Refer to the man page: :doc:`rmdef </guides/admin-guides/references/man1/rmdef.1
Delete the node node1 ::
#curl -X DELETE -k 'https://127.0.0.1/xcatws/nodes/node1?userName=root&userPW=cluster&pretty=1'
[URI:/nodes/{noderange}/attrs/{attr1,attr2,attr3 ...}] - The attributes resource for the node {noderange}
---------------------------------------------------------------------------------------------------------
@ -187,8 +190,8 @@ Refer to the man page: :doc:`makehosts </guides/admin-guides/references/man8/mak
Create the mapping of ip and hostname record for node 'node1'. ::
#curl -X POST -k 'https://127.0.0.1/xcatws/nodes/node1/host?userName=root&userPW=cluster&pretty=1'
[URI:/nodes/{noderange}/dns] - The dns record resource for the node {noderange}
-------------------------------------------------------------------------------
@ -207,8 +210,8 @@ Refer to the man page: :doc:`makedns </guides/admin-guides/references/man8/maked
Create the dns record for node 'node1'. ::
#curl -X POST -k 'https://127.0.0.1/xcatws/nodes/node1/dns?userName=root&userPW=cluster&pretty=1'
DELETE - Remove the dns record for the node {noderange}.
````````````````````````````````````````````````````````
@ -222,8 +225,8 @@ Refer to the man page: :doc:`makedns </guides/admin-guides/references/man8/maked
Delete the dns record for node node1 ::
#curl -X DELETE -k 'https://127.0.0.1/xcatws/nodes/node1/dns?userName=root&userPW=cluster&pretty=1'
[URI:/nodes/{noderange}/dhcp] - The dhcp record resource for the node {noderange}
---------------------------------------------------------------------------------
@ -240,8 +243,8 @@ Refer to the man page: :doc:`makedhcp </guides/admin-guides/references/man8/make
Create the dhcp record for node 'node1'. ::
#curl -X POST -k 'https://127.0.0.1/xcatws/nodes/node1/dhcp?userName=root&userPW=cluster&pretty=1'
DELETE - Remove the dhcp record for the node {noderange}.
`````````````````````````````````````````````````````````
@ -255,8 +258,8 @@ Refer to the man page: :doc:`makedhcp </guides/admin-guides/references/man8/make
Delete the dhcp record for node node1 ::
#curl -X DELETE -k 'https://127.0.0.1/xcatws/nodes/node1/dhcp?userName=root&userPW=cluster&pretty=1'
[URI:/nodes/{noderange}/nodestat}] - The attributes resource for the node {noderange}
-------------------------------------------------------------------------------------
@ -359,8 +362,8 @@ Refer to the man page: :doc:`rpower </guides/admin-guides/references/man1/rpower
Change the power status to on ::
#curl -X PUT -k 'https://127.0.0.1/xcatws/nodes/node1/power?userName=root&userPW=cluster&pretty=1' -H Content-Type:application/json --data '{"action":"on"}'
[URI:/nodes/{noderange}/energy] - The energy resource for the node {noderange}
------------------------------------------------------------------------------
@ -377,8 +380,8 @@ Refer to the man page: :doc:`renergy </guides/admin-guides/references/man1/rener
Get all the energy attributes. ::
#curl -X GET -k 'https://127.0.0.1/xcatws/nodes/node1/energy?userName=root&userPW=cluster&pretty=1'
{
"node1":{
"cappingmin":"272.3 W",
@ -404,8 +407,8 @@ Refer to the man page: :doc:`renergy </guides/admin-guides/references/man1/rener
Turn on the cappingstatus to [on] ::
#curl -X PUT -k 'https://127.0.0.1/xcatws/nodes/node1/energy?userName=root&userPW=cluster&pretty=1' -H Content-Type:application/json --data '{"cappingstatus":"on"}'
[URI:/nodes/{noderange}/energy/{cappingmaxmin,cappingstatus,cappingvalue ...}] - The specific energy attributes resource for the node {noderange}
-------------------------------------------------------------------------------------------------------------------------------------------------
@ -472,8 +475,8 @@ Refer to the man page: :doc:`rspconfig </guides/admin-guides/references/man1/rsp
Set the snmp community to [mycommunity]. ::
#curl -X PUT -k 'https://127.0.0.1/xcatws/nodes/node1/sp/community?userName=root&userPW=cluster&pretty=1' -H Content-Type:application/json --data '{"value":"mycommunity"}'
[URI:/nodes/{noderange}/nextboot] - The temporary bootorder resource in next boot for the node {noderange}
----------------------------------------------------------------------------------------------------------
@ -515,8 +518,8 @@ Refer to the man page: :doc:`rsetboot </guides/admin-guides/references/man1/rset
Set the bootorder for the next boot. ::
#curl -X PUT -k 'https://127.0.0.1/xcatws/nodes/node1/nextboot?userName=root&userPW=cluster&pretty=1' -H Content-Type:application/json --data '{"order":"net"}'
[URI:/nodes/{noderange}/bootstate] - The boot state resource for node {noderange}.
----------------------------------------------------------------------------------
@ -558,8 +561,8 @@ Refer to the man page: :doc:`nodeset </guides/admin-guides/references/man1/nimno
Set the next boot state for the node1. ::
#curl -X PUT -k 'https://127.0.0.1/xcatws/nodes/node1/bootstate?userName=root&userPW=cluster&pretty=1' -H Content-Type:application/json --data '{"osimage":"rhels6.4-x86_64-install-compute"}'
[URI:/nodes/{noderange}/vitals] - The vitals resources for the node {noderange}
-------------------------------------------------------------------------------
@ -950,20 +953,20 @@ Refer to the man page: :doc:`chvm </guides/admin-guides/references/man1/chvm.1>`
Set memory to 3000MB. ::
#curl -X PUT -k 'https://127.0.0.1/xcatws/nodes/node1/vm?userName=root&userPW=cluster&pretty=1' -H Content-Type:application/json --data '{"memorysize":"3000"}'
**Example2:**
Add a new 20G disk. ::
#curl -X PUT -k 'https://127.0.0.1/xcatws/nodes/node1/vm?userName=root&userPW=cluster&pretty=1' -H Content-Type:application/json --data '{"adddisk":"20G"}'
**Example3:**
Purge the disk 'hdb'. ::
#curl -X PUT -k 'https://127.0.0.1/xcatws/nodes/node1/vm?userName=root&userPW=cluster&pretty=1' -H Content-Type:application/json --data '{"purgedisk":"hdb"}'
POST - Create the vm node {noderange}.
``````````````````````````````````````
@ -985,8 +988,8 @@ Refer to the man page: :doc:`mkvm </guides/admin-guides/references/man1/mkvm.1>`
Create the vm node1 with a 30G disk, 2048M memory and 2 cpus. ::
#curl -X POST -k 'https://127.0.0.1/xcatws/nodes/node1/vm?userName=root&userPW=cluster&pretty=1' -H Content-Type:application/json --data '{"disksize":"30G","memorysize":"2048","cpucount":"2"}'
DELETE - Remove the vm node {noderange}.
````````````````````````````````````````
@ -1006,8 +1009,8 @@ Refer to the man page: :doc:`rmvm </guides/admin-guides/references/man1/rmvm.1>`
Remove the vm node1 by force and purge the disk. ::
#curl -X DELETE -k 'https://127.0.0.1/xcatws/nodes/node1/vm?userName=root&userPW=cluster&pretty=1' -H Content-Type:application/json --data '{"force":"yes","purge":"yes"}'
[URI:/nodes/{noderange}/vmclone] - The clone resource for the virtual node {noderange}.
---------------------------------------------------------------------------------------
@ -1046,8 +1049,8 @@ Create a clone master named "vmmaster" from the node1. ::
Clone the node1 from the clone master named "vmmaster". ::
#curl -X POST -k 'https://127.0.0.1/xcatws/nodes/node1/vmclone?userName=root&userPW=cluster&pretty=1' -H Content-Type:application/json --data '{"frommaster":"vmmaster"}'
[URI:/nodes/{noderange}/vmmigrate] - The virtualization resource for migration.
-------------------------------------------------------------------------------
@ -1066,8 +1069,8 @@ Refer to the man page: :doc:`rmigrate </guides/admin-guides/references/man1/rmig
Migrate node1 to target host host2. ::
#curl -X POST -k 'https://127.0.0.1/xcatws/nodes/node1/vmmigrate?userName=root&userPW=cluster&pretty=1' -H Content-Type:application/json --data '{"target":"host2"}'
Osimage resources
=================
@ -1115,14 +1118,14 @@ Refer to the man page: :doc:`copycds </guides/admin-guides/references/man8/copyc
Create osimage resources based on the ISO specified ::
#curl -X POST -k 'https://127.0.0.1/xcatws/osimages?userName=root&userPW=cluster&pretty=1' -H Content-Type:application/json --data '{"iso":"/iso/RHEL6.4-20130130.0-Server-ppc64-DVD1.iso"}'
**Example2:**
Create osimage resources based on an xCAT image or configuration file ::
#curl -X POST -k 'https://127.0.0.1/xcatws/osimages?userName=root&userPW=cluster&pretty=1' -H Content-Type:application/json --data '{"file":"/tmp/sles11.2-x86_64-install-compute.tgz"}'
[URI:/osimages/{imgname}] - The osimage resource
------------------------------------------------
@ -1176,8 +1179,8 @@ Refer to the man page: :doc:`chdef </guides/admin-guides/references/man1/chdef.1
Change the 'osvers' and 'osarch' attributes for the osiamge. ::
#curl -X PUT -k 'https://127.0.0.1/xcatws/osimages/sles11.2-ppc64-install-compute/?userName=root&userPW=cluster&pretty=1' -H Content-Type:application/json --data '{"osvers":"sles11.3","osarch":"x86_64"}'
POST - Create the osimage {imgname}.
````````````````````````````````````
@ -1195,8 +1198,8 @@ Refer to the man page: :doc:`mkdef </guides/admin-guides/references/man1/mkdef.1
Create a osimage obj with the specified parameters. ::
#curl -X POST -k 'https://127.0.0.1/xcatws/osimages/sles11.3-ppc64-install-compute?userName=root&userPW=cluster&pretty=1' -H Content-Type:application/json --data '{"osvers":"sles11.3","osarch":"ppc64","osname":"Linux","provmethod":"install","profile":"compute"}'
DELETE - Remove the osimage {imgname}.
``````````````````````````````````````
@ -1210,8 +1213,8 @@ Refer to the man page: :doc:`rmdef </guides/admin-guides/references/man1/rmdef.1
Delete the specified osimage. ::
#curl -X DELETE -k 'https://127.0.0.1/xcatws/osimages/sles11.3-ppc64-install-compute?userName=root&userPW=cluster&pretty=1'
[URI:/osimages/{imgname}/attrs/attr1,attr2,attr3 ...] - The attributes resource for the osimage {imgname}
---------------------------------------------------------------------------------------------------------
@ -1230,7 +1233,6 @@ Refer to the man page: :doc:`lsdef </guides/admin-guides/references/man1/lsdef.1
Get the specified attributes. ::
#curl -X GET -k 'https://127.0.0.1/xcatws/osimages/sles11.2-ppc64-install-compute/attrs/imagetype,osarch,osname,provmethod?userName=root&userPW=cluster&pretty=1'
{
"sles11.2-ppc64-install-compute":{
@ -1261,20 +1263,20 @@ Refer to the man page: :doc:` </guides/admin-guides/references/>`
Generates a stateless image based on the specified osimage ::
#curl -X POST -k 'https://127.0.0.1/xcatws/osimages/sles11.2-x86_64-install-compute/instance?userName=root&userPW=cluster&pretty=1' -H Content-Type:application/json --data '{"action":"gen"}'
**Example2:**
Packs the stateless image from the chroot file system based on the specified osimage ::
#curl -X POST -k 'https://127.0.0.1/xcatws/osimages/sles11.2-x86_64-install-compute/instance?userName=root&userPW=cluster&pretty=1' -H Content-Type:application/json --data '{"action":"pack"}'
**Example3:**
Exports an xCAT image based on the specified osimage ::
#curl -X POST -k 'https://127.0.0.1/xcatws/osimages/sles11.2-x86_64-install-compute/instance?userName=root&userPW=cluster&pretty=1' -H Content-Type:application/json --data '{"action":"export"}'
DELETE - Delete the stateless or statelite image instance for the osimage {imgname} from the file system
````````````````````````````````````````````````````````````````````````````````````````````````````````
@ -1288,8 +1290,8 @@ Refer to the man page: :doc:`rmimage </guides/admin-guides/references/man1/rmima
Delete the stateless image for the specified osimage ::
#curl -X DELETE -k 'https://127.0.0.1/xcatws/osimages/sles11.2-x86_64-install-compute/instance?userName=root&userPW=cluster&pretty=1'
Network Resources
=================
@ -1340,8 +1342,8 @@ Refer to the man page: :doc:`makenetworks </guides/admin-guides/references/man8/
Create the networks resources base on the network configuration on xCAT MN. ::
#curl -X POST -k 'https://127.0.0.1/xcatws/networks?userName=root&userPW=cluster&pretty=1'
[URI:/networks/{netname}] - The network resource
------------------------------------------------
@ -1360,7 +1362,6 @@ Refer to the man page: :doc:`lsdef </guides/admin-guides/references/man1/lsdef.1
Get all the attibutes for network 'network1'. ::
#curl -X GET -k 'https://127.0.0.1/xcatws/networks/network1?userName=root&userPW=cluster&pretty=1'
{
"network1":{
@ -1390,8 +1391,8 @@ Refer to the man page: :doc:`chdef </guides/admin-guides/references/man1/chdef.1
Change the attributes mgtifname=eth0 and net=10.1.0.0. ::
#curl -X PUT -k 'https://127.0.0.1/xcatws/networks/network1?userName=root&userPW=cluster&pretty=1' -H Content-Type:application/json --data '{"mgtifname":"eth0","net":"10.1.0.0"}'
POST - Create the network {netname}. DataBody: {attr1:v1,att2:v2...}.
`````````````````````````````````````````````````````````````````````
@ -1409,8 +1410,8 @@ Refer to the man page: :doc:`mkdef </guides/admin-guides/references/man1/mkdef.1
Create a network with attributes gateway=10.1.0.1, mask=255.255.0.0 ::
#curl -X POST -k 'https://127.0.0.1/xcatws/networks/network1?userName=root&userPW=cluster&pretty=1' -H Content-Type:application/json --data '{"gateway":"10.1.0.1","mask":"255.255.0.0"}'
DELETE - Remove the network {netname}.
``````````````````````````````````````
@ -1424,8 +1425,8 @@ Refer to the man page: :doc:`rmdef </guides/admin-guides/references/man1/rmdef.1
Delete the network network1 ::
#curl -X DELETE -k 'https://127.0.0.1/xcatws/networks/network1?userName=root&userPW=cluster&pretty=1'
[URI:/networks/{netname}/attrs/attr1,attr2,...] - The attributes resource for the network {netname}
---------------------------------------------------------------------------------------------------
@ -1444,7 +1445,6 @@ Refer to the man page: :doc:`lsdef </guides/admin-guides/references/man1/lsdef.1
Get the attributes {groups,mgt,netboot} for network network1 ::
#curl -X GET -k 'https://127.0.0.1/xcatws/networks/network1/attrs/gateway,mask,mgtifname,net,tftpserver?userName=root&userPW=cluster&pretty=1'
{
"network1":{
@ -1476,7 +1476,6 @@ Refer to the man page: :doc:`lsdef </guides/admin-guides/references/man1/lsdef.1
Get all the policy objects. ::
#curl -X GET -k 'https://127.0.0.1/xcatws/policy?userName=root&userPW=cluster&pretty=1'
[
"1",
@ -1505,7 +1504,6 @@ Refer to the man page: :doc:`lsdef </guides/admin-guides/references/man1/lsdef.1
Get all the attribute for policy 1. ::
#curl -X GET -k 'https://127.0.0.1/xcatws/policy/1?userName=root&userPW=cluster&pretty=1'
{
"1":{
@ -1554,8 +1552,8 @@ Refer to the man page: :doc:`chdef </guides/admin-guides/references/man1/chdef.1
Create a new policy 10. ::
#curl -X POST -k 'https://127.0.0.1/xcatws/policy/10?userName=root&userPW=cluster&pretty=1' -H Content-Type:application/json --data '{"name":"root","commands":"rpower"}'
DELETE - Remove the policy {policy_priority}.
`````````````````````````````````````````````
@ -1571,8 +1569,8 @@ Refer to the man page: :doc:`rmdef </guides/admin-guides/references/man1/rmdef.1
Delete the policy 10. ::
#curl -X DELETE -k 'https://127.0.0.1/xcatws/policy/10?userName=root&userPW=cluster&pretty=1'
[URI:/policy/{policyname}/attrs/{attr1,attr2,attr3,...}] - The attributes resource for the policy {policy_priority}
-------------------------------------------------------------------------------------------------------------------
@ -1593,7 +1591,6 @@ Refer to the man page: :doc:`lsdef </guides/admin-guides/references/man1/lsdef.1
Get the name and rule attributes for policy 1. ::
#curl -X GET -k 'https://127.0.0.1/xcatws/policy/1/attrs/name,rule?userName=root&userPW=cluster&pretty=1'
{
"1":{
@ -1627,7 +1624,6 @@ Refer to the man page: :doc:`lsdef </guides/admin-guides/references/man1/lsdef.1
Get all the group names from xCAT database. ::
#curl -X GET -k 'https://127.0.0.1/xcatws/groups?userName=root&userPW=cluster&pretty=1'
[
"__mgmtnode",
@ -1653,7 +1649,6 @@ Refer to the man page: :doc:`lsdef </guides/admin-guides/references/man1/lsdef.1
Get all the attibutes for group 'all'. ::
#curl -X GET -k 'https://127.0.0.1/xcatws/groups/all?userName=root&userPW=cluster&pretty=1'
{
"all":{
@ -1680,6 +1675,7 @@ Change the attributes mgt=dfm and netboot=yaboot. ::
#curl -X PUT -k 'https://127.0.0.1/xcatws/groups/all?userName=root&userPW=cluster&pretty=1' -H Content-Type:application/json --data '{"mgt":"dfm","netboot":"yaboot"}'
[URI:/groups/{groupname}/attrs/{attr1,attr2,attr3 ...}] - The attributes resource for the group {groupname}
-----------------------------------------------------------------------------------------------------------
@ -1758,7 +1754,6 @@ Refer to the man page: :doc:`lsdef </guides/admin-guides/references/man1/lsdef.1
Get the 'master' and 'domain' configuration. ::
#curl -X GET -k 'https://127.0.0.1/xcatws/globalconf/attrs/master,domain?userName=root&userPW=cluster&pretty=1'
{
"clustersite":{
@ -1786,8 +1781,8 @@ Refer to the man page: :doc:`chdef </guides/admin-guides/references/man1/chdef.1
Change/Add the domain attribute. ::
#curl -X PUT -k 'https://127.0.0.1/xcatws/globalconf/attrs/domain?userName=root&userPW=cluster&pretty=1' -H Content-Type:application/json --data '{"domain":"cluster.com"}'
DELETE - Remove the site attributes.
````````````````````````````````````
@ -1803,8 +1798,8 @@ Refer to the man page: :doc:`chdef </guides/admin-guides/references/man1/chdef.1
Remove the domain configure. ::
#curl -X DELETE -k 'https://127.0.0.1/xcatws/globalconf/attrs/domain?userName=root&userPW=cluster&pretty=1'
Service Resources
=================
@ -1826,8 +1821,8 @@ Refer to the man page: :doc:`makedns </guides/admin-guides/references/man8/maked
Initialize the dns service. ::
#curl -X POST -k 'https://127.0.0.1/xcatws/services/dns?userName=root&userPW=cluster&pretty=1'
[URI:/services/dhcp] - The dhcp service resource.
-------------------------------------------------
@ -1844,8 +1839,8 @@ Refer to the man page: :doc:`makedhcp </guides/admin-guides/references/man8/make
Create the dhcpd.conf and restart the dhcpd. ::
#curl -X POST -k 'https://127.0.0.1/xcatws/services/dhcp?userName=root&userPW=cluster&pretty=1'
[URI:/services/host] - The hostname resource.
---------------------------------------------
@ -1862,8 +1857,8 @@ Refer to the man page: :doc:`makehosts </guides/admin-guides/references/man8/mak
Create the ip/hostname records for all the nodes to /etc/hosts. ::
#curl -X POST -k 'https://127.0.0.1/xcatws/services/host?userName=root&userPW=cluster&pretty=1'
[URI:/services/slpnodes] - The nodes which support SLP in the xCAT cluster
--------------------------------------------------------------------------
@ -1880,7 +1875,6 @@ Refer to the man page: :doc:`lsslp </guides/admin-guides/references/man1/lsslp.1
Get all the nodes which support slp in the network. ::
#curl -X GET -k 'https://127.0.0.1/xcatws/services/slpnodes?userName=root&userPW=cluster&pretty=1'
{
"ngpcmm01":{
@ -2045,8 +2039,8 @@ PUT - Change the node table attibutes for {noderange}.
Change the nodetype.arch and noderes.netboot attributes for nodes node1,node2. ::
#curl -X PUT -k 'https://127.0.0.1/xcatws/tables/nodetype,noderes/nodes/node1,node2?userName=root&userPW=cluster&pretty=1' -H Content-Type:application/json --data '{"nodetype":{"arch":"x86_64"},"noderes":{"netboot":"xnba"}}'
[URI:/tables/{tablelist}/nodes/nodes/{noderange}/{attrlist}] - The node table attributes resource
-------------------------------------------------------------------------------------------------
@ -2166,8 +2160,8 @@ PUT - Change the non-node table attibutes for the row that matches the {keys}.
Create a route row in the routes table. ::
#curl -X PUT -k 'https://127.0.0.1/xcatws/tables/routes/rows/routename=privnet?userName=root&userPW=cluster&pretty=1' -H Content-Type:application/json --data '{"net":"10.0.1.0","mask":"255.255.255.0","gateway":"10.0.1.254","ifname":"eth1"}'
DELETE - Delete rows from a non-node table that have the attribute values specified in {keys}.
``````````````````````````````````````````````````````````````````````````````````````````````
@ -2179,8 +2173,8 @@ DELETE - Delete rows from a non-node table that have the attribute values specif
Delete a route row which routename=privnet in the routes table. ::
#curl -X DELETE -k 'https://127.0.0.1/xcatws/tables/routes/rows/routename=privnet?userName=root&userPW=cluster&pretty=1'
[URI:/tables/{tablelist}/rows/{keys}/{attrlist}] - The non-node table attributes resource
-----------------------------------------------------------------------------------------