diff --git a/buildlocal.sh b/buildlocal.sh index f44ec3762..197f55f54 100755 --- a/buildlocal.sh +++ b/buildlocal.sh @@ -23,6 +23,13 @@ echo "CURDIR is $CURDIR" echo "OSNAME is $OSNAME!" echo "NAMEALL is $NAMEALL" +grep -i 'SUSE' /etc/issue +if [ $? -eq 0 ]; then + echo "This is a SUSE system!" + OS="SUSE"; +fi + + ls $CURDIR/makerpm if [ $? -gt 0 ]; then @@ -78,9 +85,16 @@ else #This is not an Ubuntu system echo "This is an $OSNAME system" - rm -rf /root/rpmbuild/RPMS/noarch/* - rm -rf /root/rpmbuild/RPMS/x86_64/* - rm -rf /root/rpmbuild/RPMS/ppc64/* + if [ "$OS" = "SUSE" ]; then + rm -rf /usr/src/packages/RPMS/noarch/* + rm -rf /usr/src/packages/RPMS/x86_64/* + rm -rf /usr/src/packages/RPMS/ppc64/* + else + rm -rf /root/rpmbuild/RPMS/noarch/* + rm -rf /root/rpmbuild/RPMS/x86_64/* + rm -rf /root/rpmbuild/RPMS/ppc64/* + fi + mkdir -p $CURDIR/build/ #always build perl-xCAT @@ -113,13 +127,20 @@ echo "This is an $OSNAME system" fi done - cp /root/rpmbuild/RPMS/noarch/* $CURDIR/build/ - cp /root/rpmbuild/RPMS/x86_64/* $CURDIR/build/ - cp /root/rpmbuild/RPMS/ppc64/* $CURDIR/build/ + if [ "$OS" = "SUSE" ]; then + cp /usr/src/packages/RPMS/noarch/* $CURDIR/build/ + cp /usr/src/packages/RPMS/x86_64/* $CURDIR/build/ + cp /usr/src/packages/RPMS/ppc64/* $CURDIR/build/ + else + cp /root/rpmbuild/RPMS/noarch/* $CURDIR/build/ + cp /root/rpmbuild/RPMS/x86_64/* $CURDIR/build/ + cp /root/rpmbuild/RPMS/ppc64/* $CURDIR/build/ + fi #begin to create repo for redhat platform - if [ "$OSNAME" != "AIX" ]; then + grep -i 'Red' /etc/issue; + if [ "$OSNAME" != "AIX" -a $? -eq 0 ]; then cat >$CURDIR/build/xCAT-core.repo << EOF [xcat-2-core] name=xCAT 2 Core packages @@ -129,7 +150,9 @@ gpgcheck=0 EOF cp $CURDIR/build/xCAT-core.repo /etc/yum.repos.d/ - + else + rm -f /etc/zypp/repos.d/xCAT-core.repo + zypper ar file://$CURDIR/build xCAT-core fi fi diff --git a/perl-xCAT/xCAT/DSHCLI.pm b/perl-xCAT/xCAT/DSHCLI.pm index fa3467597..02db73961 100644 --- a/perl-xCAT/xCAT/DSHCLI.pm +++ b/perl-xCAT/xCAT/DSHCLI.pm @@ -5207,6 +5207,7 @@ sub build_append_rsync push @::appendlines,$line; } my $src_file = $1; # append file left of arror + my $orig_src_file = $1; # append file left of arror # it will be sync'd to $nodesyncfiledir/$append_file my $dest_file = $nodesyncfiledir; $dest_file .= $src_file; @@ -5235,7 +5236,7 @@ sub build_append_rsync # to pick up files from /var/xcat/syncfiles... if ($onServiceNode == 1) { my $newsrcfile = $syncdir; # add SN syndir on front - $newsrcfile .= $src_file; + $newsrcfile .= $orig_src_file; $src_file=$newsrcfile; } # destination file name diff --git a/perl-xCAT/xCAT/DSHCore.pm b/perl-xCAT/xCAT/DSHCore.pm index 1ca50ba63..9e940ca01 100644 --- a/perl-xCAT/xCAT/DSHCore.pm +++ b/perl-xCAT/xCAT/DSHCore.pm @@ -253,64 +253,6 @@ use strict; -#--------------------------------------------------------------------------- - -=head3 - ifconfig_inet - - Builds a list of all IP Addresses bound to the local host and - stores them in a global list - - Arguments: - None - - Returns: - None - - Globals: - @local_inet - - Error: - None - - Example: - xCAT::DSHCore->ifconfig_inet; - - Comments: - Internal routine only - -=cut - -#--------------------------------------------------------------------------- - -sub ifconfig_inet -{ - my @local_inet = (); - - if ($^O eq 'aix') - { - my @ip_address = (); - my @output = `/usr/sbin/ifconfig -a`; - - foreach my $line (@output) - { - ($line =~ /inet ((\d{1,3}?\.){3}(\d){1,3})\s/o) - && (push @local_inet, $1); - } - } - - elsif ($^O eq 'linux') - { - my @ip_address = (); - my @output = `/sbin/ifconfig -a`; - - foreach my $line (@output) - { - ($line =~ /inet addr:((\d{1,3}?\.){3}(\d){1,3})\s/o) - && (push @local_inet, $1); - } - } -} #--------------------------------------------------------------------------- diff --git a/perl-xCAT/xCAT/NetworkUtils.pm b/perl-xCAT/xCAT/NetworkUtils.pm index cd780d9af..1bd6397e0 100755 --- a/perl-xCAT/xCAT/NetworkUtils.pm +++ b/perl-xCAT/xCAT/NetworkUtils.pm @@ -697,19 +697,26 @@ sub get_nic_ip # Base address:0x2600 Memory:fbfe0000-fc0000080 # # eth1 ... + # Redhat7 + #eth0: flags=4163 mtu 1500 + # inet 10.1.0.178 netmask 255.255.0.0 broadcast 10.1.255.255 # ############################################################## my @adapter= split /\n{2,}/, $result; foreach ( @adapter ) { - if ( !($_ =~ /LOOPBACK / ) and - $_ =~ /UP / and - $_ =~ /$mode / ) { + if ( !($_ =~ /LOOPBACK/ ) and + $_ =~ /UP( |,|>)/ and + $_ =~ /$mode/ ) { my @ip = split /\n/; for my $ent ( @ip ) { if ($ent =~ /^(eth\d|ib\d|hf\d)\s+/) { $nic = $1; - } - if ( $ent =~ /^\s*inet addr:\s*(\d+\.\d+\.\d+\.\d+)/ ) { + } + if ($ent =~ /^(eth\d:|ib\d:|hf\d:)\s+/) { + $nic = $1; + } + $ent=~ s/addr://; # works for Redhat7 also + if ( $ent =~ /^\s*inet \s*(\d+\.\d+\.\d+\.\d+)/ ) { $iphash{$nic} = $1; next; } @@ -2306,6 +2313,7 @@ sub isValidHostname return 0; } + #------------------------------------------------------------------------------- =head3 isValidFQDN diff --git a/xCAT-genesis-builder/install b/xCAT-genesis-builder/install index 1ee268a35..62db3a414 100755 --- a/xCAT-genesis-builder/install +++ b/xCAT-genesis-builder/install @@ -253,9 +253,6 @@ dracut_install /usr/share/zoneinfo/posix/America/Knox_IN dracut_install /usr/share/zoneinfo/posix/America/Goose_Bay dracut_install /usr/share/zoneinfo/posix/EET dracut_install /usr/share/zoneinfo/posix/EST5EDT -dracut_install /usr/share/zoneinfo/posix/Mideast/Riyadh89 -dracut_install /usr/share/zoneinfo/posix/Mideast/Riyadh88 -dracut_install /usr/share/zoneinfo/posix/Mideast/Riyadh87 dracut_install /usr/share/zoneinfo/posix/MST dracut_install /usr/share/zoneinfo/posix/Iceland dracut_install /usr/share/zoneinfo/posix/Atlantic/Faeroe @@ -396,7 +393,6 @@ dracut_install /usr/share/zoneinfo/posix/NZ-CHAT dracut_install /usr/share/zoneinfo/posix/Asia/Istanbul dracut_install /usr/share/zoneinfo/posix/Asia/Kuwait dracut_install /usr/share/zoneinfo/posix/Asia/Saigon -dracut_install /usr/share/zoneinfo/posix/Asia/Riyadh89 dracut_install /usr/share/zoneinfo/posix/Asia/Urumqi dracut_install /usr/share/zoneinfo/posix/Asia/Brunei dracut_install /usr/share/zoneinfo/posix/Asia/Ujung_Pandang @@ -438,7 +434,6 @@ dracut_install /usr/share/zoneinfo/posix/Asia/Tokyo dracut_install /usr/share/zoneinfo/posix/Asia/Macao dracut_install /usr/share/zoneinfo/posix/Asia/Riyadh dracut_install /usr/share/zoneinfo/posix/Asia/Rangoon -dracut_install /usr/share/zoneinfo/posix/Asia/Riyadh88 dracut_install /usr/share/zoneinfo/posix/Asia/Jakarta dracut_install /usr/share/zoneinfo/posix/Asia/Aden dracut_install /usr/share/zoneinfo/posix/Asia/Calcutta @@ -476,7 +471,6 @@ dracut_install /usr/share/zoneinfo/posix/Asia/Tel_Aviv dracut_install /usr/share/zoneinfo/posix/Asia/Taipei dracut_install /usr/share/zoneinfo/posix/Asia/Kabul dracut_install /usr/share/zoneinfo/posix/Asia/Macau -dracut_install /usr/share/zoneinfo/posix/Asia/Riyadh87 dracut_install /usr/share/zoneinfo/posix/Asia/Choibalsan dracut_install /usr/share/zoneinfo/posix/Asia/Vientiane dracut_install /usr/share/zoneinfo/posix/Asia/Dacca diff --git a/xCAT-genesis-scripts/bin/bmcsetup b/xCAT-genesis-scripts/bin/bmcsetup index d140f2dc2..4cdfeac75 100755 --- a/xCAT-genesis-scripts/bin/bmcsetup +++ b/xCAT-genesis-scripts/bin/bmcsetup @@ -204,7 +204,7 @@ for bmcu in $BMCUS; do if [ "$bmcu" = "" ]; then continue; fi DISABLEUSERS="1 2 3 4" if [ ! -z "$LOCKEDUSERS" ]; then - USERSLOT=`ipmitool -d $idev user list $LANCHAN |grep -v ^ID|awk '{print $1 " " $2}'|grep " $BMCUS"|awk '{print $1}'` + USERSLOT=`ipmitool -d $idev user list $LANCHAN |grep -v ^ID|awk '{print $1 " " $2}'|grep -w "$BMCUS"|awk '{print $1}'` if [ -z "$USERSLOT" ]; then USERSLOT=4 fi @@ -239,7 +239,7 @@ done TRIES=0 # Last param in ipmitool user priv is the channel to set it on. # Penguin boxes are all channel 2 -CURRPRIV=`ipmitool -d $idev user list 1|grep ^$USERSLOT|awk '{print $6}'` +CURRPRIV=`ipmitool -d $idev user list $LANCHAN|grep ^$USERSLOT|awk '{print $6}'` if [ "$CURRPRIV" != "ADMINISTRATOR" ]; then while ! ipmitool -d $idev user priv $USERSLOT 4 $LANCHAN; do sleep 1 diff --git a/xCAT-server/lib/xcat/plugins/dhcp.pm b/xCAT-server/lib/xcat/plugins/dhcp.pm index 1a936d5c8..21c5456b9 100755 --- a/xCAT-server/lib/xcat/plugins/dhcp.pm +++ b/xCAT-server/lib/xcat/plugins/dhcp.pm @@ -2647,6 +2647,7 @@ sub newconfig push @dhcpconf, "#xCAT generated dhcp configuration\n"; push @dhcpconf, "\n"; push @dhcpconf, "authoritative;\n"; + push @dhcpconf, "option conf-file code 209 = text;\n"; push @dhcpconf, "option space isan;\n"; push @dhcpconf, "option isan-encap-opts code 43 = encapsulate isan;\n"; push @dhcpconf, "option isan.iqn code 203 = string;\n"; diff --git a/xCAT-server/lib/xcat/plugins/petitboot.pm b/xCAT-server/lib/xcat/plugins/petitboot.pm index 32efe409d..3e44a097d 100644 --- a/xCAT-server/lib/xcat/plugins/petitboot.pm +++ b/xCAT-server/lib/xcat/plugins/petitboot.pm @@ -447,20 +447,22 @@ sub process_request { if ($do_dhcpsetup) { foreach my $node (@normalnodeset) { - - my $fpath = "http://9.3.190.175/tftpboot/petitboot/$node"; - if ($request->{'_disparatetftp'}->[0]) { #reading hint from preprocess_command - $sub_req->({command=>['makedhcp'], - node=> [$node], - arg=>['-l','-s','conf-file = \"'.$fpath.'\";']},$callback); - } else { - $sub_req->({command=>['makedhcp'], - node=> [$node], - arg=>['-s','conf-file = \"'.$fpath.'\";']},$callback); - } + my $server = xCAT::TableUtils->GetMasterNodeName($node); + my $ipfn = xCAT::NetworkUtils->my_ip_facing($server); + if(($server != 1) and defined($ipfn)) { + my $fpath = "http://$ipfn/tftpboot/petitboot/$node"; + if ($request->{'_disparatetftp'}->[0]) { #reading hint from preprocess_command + $sub_req->({command=>['makedhcp'], + node=> [$node], + arg=>['-l','-s','option conf-file \"'.$fpath.'\";']},$callback); + } else { + $sub_req->({command=>['makedhcp'], + node=> [$node], + arg=>['-s','option conf-file \"'.$fpath.'\";']},$callback); + } + } } - - } + } } #now run the end part of the prescripts diff --git a/xCAT-server/lib/xcat/plugins/tabutils.pm b/xCAT-server/lib/xcat/plugins/tabutils.pm index 3d5496baa..3001c0546 100644 --- a/xCAT-server/lib/xcat/plugins/tabutils.pm +++ b/xCAT-server/lib/xcat/plugins/tabutils.pm @@ -2975,6 +2975,21 @@ sub getAttribs # This is a comment # # +# +# +#PCM +#setAttribs +#networks
+# +# 10.0.1.0 +# 255.255.255.0 +# +# +# mynet +# 10.0.1.254 +# +# + sub setAttribs { my $request = shift; diff --git a/xCAT-server/share/xcat/netboot/sles/genimage b/xCAT-server/share/xcat/netboot/sles/genimage index 6746625ee..daedcca5a 100755 --- a/xCAT-server/share/xcat/netboot/sles/genimage +++ b/xCAT-server/share/xcat/netboot/sles/genimage @@ -177,7 +177,7 @@ if ($netdriver) { # Add the default driver list if ($arch eq 'x86' or $arch eq 'x86_64') { - push @ndrivers, qw/tg3 bnx2 bnx2x e1000 e1000e igb mlx_en be2net/; + push @ndrivers, qw/tg3 bnx2 bnx2x e1000 e1000e virtio_net virtio_balloon igb mlx_en be2net/; } elsif ($arch eq 'ppc64') { push @ndrivers, qw/tg3 e1000 e1000e igb ibmveth ehea be2net/; } elsif ($arch eq "s390x") { diff --git a/xCAT-server/xCAT-wsapi/genrestapidoc.pm b/xCAT-server/xCAT-wsapi/genrestapidoc.pm index 461fe3c89..144071f0c 100755 --- a/xCAT-server/xCAT-wsapi/genrestapidoc.pm +++ b/xCAT-server/xCAT-wsapi/genrestapidoc.pm @@ -54,14 +54,14 @@ my @apigroups = ( { groupname => 'services', header => "Service Resources", - desc => "The URI list which can be used to manage the dns and dhcp services on xCAT MN.", + desc => "The URI list which can be used to manage the host, dns and dhcp services on xCAT MN.", resources => ['dns','dhcp','host', 'slpnodes', 'specific_slpnodes',] }, { groupname => 'tables', header => "Table Resources", - desc => "URI list which can be used to create, query, change global configuration.", - resources => ['table_nodes', 'table_rows'] + desc => "URI list which can be used to create, query, change table entries.", + resources => ['table_nodes', 'table_nodes_attrs', 'table_all_rows', 'table_rows', 'table_rows_attrs'] }, ); diff --git a/xCAT-server/xCAT-wsapi/xcatws.cgi b/xCAT-server/xCAT-wsapi/xcatws.cgi index e70645b66..c63a2b164 100755 --- a/xCAT-server/xCAT-wsapi/xcatws.cgi +++ b/xCAT-server/xCAT-wsapi/xcatws.cgi @@ -2,15 +2,1128 @@ # IBM(c) 2014 EPL license http://www.eclipse.org/legal/epl-v10.html use strict; use CGI qw/:standard/; #todo: remove :standard when the code only uses object oriented interface -#use JSON; #todo: require this dynamically later on so that installations that do not use xcatws.cgi do not need perl-JSON use Data::Dumper; #talk to the server use Socket; use IO::Socket::INET; use IO::Socket::SSL; -use lib "/opt/xcat/lib/perl"; -use xCAT::Table; + +# The hash %URIdef defines all the xCAT resources which can be access from Web Service. +# This script will be called when a https request with the URI started with /xcatws/ is sent to xCAT Web Service +# Inside this script: +# 1. The main body parses the URI and parameters +# 2. Base on the URI, go through the %URIdef to find the matched resource by the 'matcher' which is defined for each resource +# 3. Call the 'fhandler' which is defined in the resource to communicate with xcatd and get the xml response +# 3.1 The 'fhandler' generates the xml request base on the resource, parameters and http method 'GET|PUT|POST|DELETE', sends to xcatd and then get the xml response +# 4. Call the 'outhdler' which is defined in the resource to parse the xml response and translate it to JSON format +# 5. Output the http response to STDOUT +# +# Refer to the $URIdef{node}->{allnode} and $URIdef{node}->{nodeallattr} for your new created resource definition. +# +# |--node - Resource Group +# | `--allnode - Resource Name +# | `--desc - Description for the Resource +# | `--desc[1..10] - Additional description for the Resource +# | `--matcher - The matcher which is used to match the URI to the Resource +# | `--GET - The info is used to handle the GET request +# | `--desc - Description for the GET operation +# | `--desc[1..10] - Additional description for the GET operation +# | `--usage - Usage message. The format must be '|Parameters for the GET request|Returns for the GET request|'. The message in the '|' can be black, but the delimiter '|' must be kept. +# | `--example - Example message. The format must be '|Description|GET|URI PUT/POST_data|Return Msg|'. The messages in the four sections must be completed. +# | `--cmd - The xCAT command line coammnd which will be used to complete the request. It's not a must have attribute. +# | `--fhandler - The call back subroutine which is used to handle the GET request. Generally, it parses the parameters from request and then call xCAT command. This subroutine can be exclusive or shared. +# | `--outhdler - The call back subroutine which is used to handle the GET request. Generally, it parses the xml output from the 'fhandler' and then format the output to JSON. This subroutine can be exclusive or shared. +# | `--PUT - The info is used to handle the PUT request +# | `--POST - The info is used to handle the POST request +# | `--DELETE - The info is used to handle the DELETE request + +# The common messages which can be used in the %URIdef +my %usagemsg = ( + objreturn => "Json format: An object which includes multiple \' : {att:value, attr:value ...}\' pairs.", + objchparam => "Json format: An object which includes multiple \'att:value\' pairs.", + non_getreturn => "No output when execution is successfull. Otherwise output the error information in the Standard Error Format: {error:[msg1,msg2...],errocode:errornum}." +); + +my %URIdef = ( + #### definition for node resources + nodes => { + allnode => { + desc => "[URI:/nodes] - The node list resource.", + desc1 => "This resource can be used to display all the nodes which have been defined in the xCAT database.", + matcher => '^/nodes$', + GET => { + desc => "Get all the nodes in xCAT.", + desc1 => "The attributes details for the node will not be displayed.", + usage => "||Json format: An array of node names.|", + example => "|Get all the node names from xCAT database.|GET|/nodes|[\n \"node1\",\n \"node2\",\n \"node3\",\n]|", + cmd => "lsdef", + fhandler => \&defhdl, + outhdler => \&defout_remove_appended_type, + } + }, + nodeallattr => { + desc => "[URI:/nodes/{noderange}] - The node resource", + matcher => '^/nodes/[^/]*$', + GET => { + desc => "Get all the attibutes for the node {noderange}.", + usage => "||$usagemsg{objreturn}|", + example => "|Get all the attibutes for node \'node1\'.|GET|/nodes/node1|{\n \"node1\":{\n \"profile\":\"compute\",\n \"netboot\":\"xnba\",\n \"arch\":\"x86_64\",\n \"mgt\":\"ipmi\",\n \"groups\":\"all\",\n ...\n }\n}|", + cmd => "lsdef", + fhandler => \&defhdl, + outhdler => \&defout, + }, + PUT => { + desc => "Change the attibutes for the node {noderange}.", + usage => "|$usagemsg{objchparam} DataBody: {attr1:v1,att2:v2,...}.|$usagemsg{non_getreturn}|", + example => "|Change the attributes mgt=dfm and netboot=yaboot.|PUT|/nodes/node1 {\"mgt\":\"dfm\",\"netboot\":\"yaboot\"}||", + cmd => "chdef", + fhandler => \&defhdl, + outhdler => \&noout, + }, + POST => { + desc => "Create the node {noderange}.", + usage => "|$usagemsg{objchparam} DataBody: {attr1:v1,att2:v2,...}.|$usagemsg{non_getreturn}|", + example => "|Create a node with attributes groups=all, mgt=dfm and netboot=yaboot|POST|/nodes/node1 {\"groups\":\"all\",\"mgt\":\"dfm\",\"netboot\":\"yaboot\"}||", + cmd => "mkdef", + fhandler => \&defhdl, + outhdler => \&noout, + }, + DELETE => { + desc => "Remove the node {noderange}.", + usage => "||$usagemsg{non_getreturn}|", + example => "|Delete the node node1|DELETE|/nodes/node1||", + cmd => "rmdef", + fhandler => \&defhdl, + outhdler => \&noout, + }, + }, + nodeattr => { + desc => "[URI:/nodes/{noderange}/attrs/{attr1,attr2,attr3 ...}] - The attributes resource for the node {noderange}", + matcher => '^/nodes/[^/]*/attrs/\S+$', + GET => { + desc => "Get the specific attributes for the node {noderange}.", + usage => "||$usagemsg{objreturn}|", + example => "|Get the attributes {groups,mgt,netboot} for node node1|GET|/nodes/node1/attrs/groups,mgt,netboot|{\n \"node1\":{\n \"netboot\":\"xnba\",\n \"mgt\":\"ipmi\",\n \"groups\":\"all\"\n }\n}|", + cmd => "lsdef", + fhandler => \&defhdl, + outhdler => \&defout, + }, + PUT_backup => { + desc => "Change attributes for the node {noderange}. DataBody: {attr1:v1,att2:v2,att3:v3 ...}.", + usage => "||An array of node objects.|", + example => "|Get the attributes {groups,mgt,netboot} for node node1|GET|/nodes/node1/attrs/groups;mgt;netboot||", + cmd => "chdef", + fhandler => \&defhdl, + outhdler => \&noout, + } + }, + nodestat => { + desc => "[URI:/nodes/{noderange}/nodestat}] - The attributes resource for the node {noderange}", + matcher => '^/nodes/[^/]*/nodestat$', + GET => { + desc => "Get the running status for the node {noderange}.", + usage => "||$usagemsg{objreturn}|", + example => "|Get the running status for node node1|GET|/nodes/node1/nodestat|x|", + cmd => "nodestat", + fhandler => \&actionhdl, + outhdler => \&actionout, + }, + }, + nodehost => { + desc => "[URI:/nodes/{noderange}/host] - The mapping of ip and hostname for the node {noderange}", + matcher => '^/nodes/[^/]*/host$', + POST => { + desc => "Create the mapping of ip and hostname record for the node {noderange}.", + usage => "||$usagemsg{non_getreturn}|", + example => "|Create the mapping of ip and hostname record for node \'node1\'.|POST|/nodes/node1/host||", + cmd => "makehosts", + fhandler => \&actionhdl, + outhdler => \&noout, + }, + }, + nodedns => { + desc => "[URI:/nodes/{noderange}/dns] - The dns record resource for the node {noderange}", + matcher => '^/nodes/[^/]*/dns$', + POST => { + desc => "Create the dns record for the node {noderange}.", + desc1 => "The prerequisite of the POST operation is the mapping of ip and noderange for the node has been added in the /etc/hosts.", + usage => "||$usagemsg{non_getreturn}|", + example => "|Create the dns record for node \'node1\'.|POST|/nodes/node1/dns||", + cmd => "makedns", + fhandler => \&actionhdl, + outhdler => \&noout, + }, + DELETE => { + desc => "Remove the dns record for the node {noderange}.", + usage => "||$usagemsg{non_getreturn}|", + example => "|Delete the dns record for node node1|DELETE|/nodes/node1/dns||", + cmd => "makedns", + fhandler => \&actionhdl, + outhdler => \&noout, + }, + }, + nodedhcp => { + desc => "[URI:/nodes/{noderange}/dhcp] - The dhcp record resource for the node {noderange}", + matcher => '^/nodes/[^/]*/dhcp$', + POST => { + desc => "Create the dhcp record for the node {noderange}.", + usage => "||$usagemsg{non_getreturn}|", + example => "|Create the dhcp record for node \'node1\'.|POST|/nodes/node1/dhcp||", + cmd => "makedhcp", + fhandler => \&actionhdl, + outhdler => \&noout, + }, + DELETE => { + desc => "Remove the dhcp record for the node {noderange}.", + usage => "||$usagemsg{non_getreturn}|", + example => "|Delete the dhcp record for node node1|DELETE|/nodes/node1/dhcp||", + cmd => "makedhcp", + fhandler => \&actionhdl, + outhdler => \&noout, + }, + }, + power => { + desc => "[URI:/nodes/{noderange}/power] - The power resource for the node {noderange}", + matcher => '^/nodes/[^/]*/power$', + GET => { + desc => "Get the power status for the node {noderange}.", + usage => "||$usagemsg{objreturn}|", + example => "|Get the power status.|GET|/nodes/node1/power|{\n \"node1\":{\n \"power\":\"on\"\n }\n}|", + cmd => "rpower", + fhandler => \&actionhdl, + outhdler => \&actionout, + }, + PUT => { + desc => "Change power status for the node {noderange}.", + usage => "|Json Formatted DataBody: {action:on/off/reset ...}.|$usagemsg{non_getreturn}|", + example => "|Change the power status to on|PUT|/nodes/node1/power {\"action\":\"on\"}||", + cmd => "rpower", + fhandler => \&actionhdl, + outhdler => \&noout, + } + }, + energy => { + desc => "[URI:/nodes/{noderange}/energy] - The energy resource for the node {noderange}", + matcher => '^/nodes/[^/]*/energy$', + GET => { + desc => "Get all the energy status for the node {noderange}.", + usage => "||$usagemsg{objreturn}|", + example => "|Get all the energy attributes.|GET|/nodes/node1/energy|{\n \"node1\":{\n \"cappingmin\":\"272.3 W\",\n \"cappingmax\":\"354.0 W\"\n ...\n }\n}|", + cmd => "renergy", + fhandler => \&actionhdl, + outhdler => \&actionout, + }, + PUT => { + desc => "Change energy attributes for the node {noderange}.", + usage => "|$usagemsg{objchparam} DataBody: {powerattr:value}.|$usagemsg{non_getreturn}|", + example => "|Turn on the cappingstatus to [on]|PUT|/nodes/node1/energy {\"cappingstatus\":\"on\"}||", + cmd => "renergy", + fhandler => \&actionhdl, + outhdler => \&noout, + } + }, + energyattr => { + disable => 1, + desc => "[URI:/nodes/{noderange}/energy/{cappingmaxmin,cappingstatus,cappingvalue ...}] - The specific energy attributes resource for the node {noderange}", + matcher => '^/nodes/[^/]*/energy/\S+$', + GET => { + desc => "Get the specific energy attributes cappingmaxmin,cappingstatus,cappingvalue ... for the node {noderange}.", + usage => "||$usagemsg{objreturn}|", + example => "|Get the energy attributes which are specified in the URI.|GET|/nodes/node1/energy/cappingmaxmin,cappingstatus|{\n \"node1\":{\n \"cappingmin\":\"272.3 W\",\n \"cappingmax\":\"354.0 W\"\n }\n}|", + cmd => "renergy", + fhandler => \&actionhdl, + outhdler => \&actionout, + }, + PUT_backup => { + desc => "Change energy attributes for the node {noderange}. ", + usage => "|$usagemsg{objchparam} DataBody: {powerattr:value}.|$usagemsg{non_getreturn}|", + example => "|Turn on the cappingstatus to [on]|PUT|/nodes/node1/energy {\"cappingstatus\":\"on\"}||", + cmd => "renergy", + fhandler => \&actionhdl, + outhdler => \&noout, + } + }, + serviceprocessor => { + disable => 1, + desc => "[URI:/nodes/{noderange}/sp/{community|ip|netmask|...}] - The attribute resource of service processor for the node {noderange}", + matcher => '^/nodes/[^/]*/sp/\S+$', + GET => { + desc => "Get the specific attributes for service processor resource.", + usage => "||$usagemsg{objreturn}|", + example => "|Get the snmp community for the service processor of node1.|GET|/nodes/node1/sp/community|{\n \"node1\":{\n \"SP SNMP Community\":\"public\"\n }\n}|", + cmd => "rspconfig", + fhandler => \&actionhdl, + outhdler => \&actionout, + }, + PUT => { + desc => "Change the specific attributes for the service processor resource. ", + usage => "|$usagemsg{objchparam} DataBody: {community:public}.|$usagemsg{non_getreturn}|", + example => "|Set the snmp community to [mycommunity].|PUT|/nodes/node1/sp/community {\"value\":\"mycommunity\"}||", + cmd => "rspconfig", + fhandler => \&actionhdl, + outhdler => \&noout, + } + }, + macaddress => { + disable => 1, + desc => "[URI:/nodes/{noderange}/mac] - The mac address resource for the node {noderange}", + matcher => '^/nodes/[^/]*/mac$', + GET => { + desc => "Get the mac address for the node {noderange}. Generally, it also updates the mac attribute of the node.", + cmd => "getmacs", + fhandler => \&common, + }, + }, + nextboot => { + desc => "[URI:/nodes/{noderange}/nextboot] - The temporary bootorder resource in next boot for the node {noderange}", + matcher => '^/nodes/[^/]*/nextboot$', + GET => { + desc => "Get the next bootorder.", + usage => "||$usagemsg{objreturn}|", + example => "|Get the bootorder for the next boot. (It's only valid after setting.)|GET|/nodes/node1/nextboot|{\n \"node1\":{\n \"nextboot\":\"Network\"\n }\n}|", + cmd => "rsetboot", + fhandler => \&actionhdl, + outhdler => \&actionout, + }, + PUT => { + desc => "Change the next boot order. ", + usage => "|$usagemsg{objchparam} DataBody: {order:net/hd}.|$usagemsg{non_getreturn}|", + example => "|Set the bootorder for the next boot.|PUT|/nodes/node1/nextboot {\"order\":\"net\"}||", + cmd => "rsetboot", + fhandler => \&actionhdl, + outhdler => \&noout, + } + }, + bootorder => { + desc => "[URI:/nodes/{noderange}/bootorder] - The permanent bootorder resource for the node {noderange}", + matcher => '^/nodes/[^/]*/bootorder$', + GET => { + desc => "Get the permanent boot order.", + usage => "|?|?|", + example => "|Get the permanent bootorder for the node1.|GET|/nodes/node1/bootorder|?|", + cmd => "rbootseq", + fhandler => \&actionhdl, + outhdler => \&actionout, + }, + PUT => { + desc => "Change the boot order. DataBody: {\"order\":\"net,hd\"}.", + usage => "|Put data: Json formatted order:value pair.|?|", + example => "|Set the permanent bootorder for the node1.|PUT|/nodes/node1/bootorder|?|", + cmd => "rbootseq", + fhandler => \&actionhdl, + outhdler => \&noout, + } + }, + vitals => { + desc => "[URI:/nodes/{noderange}/vitals] - The vitals resources for the node {noderange}", + matcher => '^/nodes/[^/]*/vitals$', + GET => { + desc => "Get all the vitals attibutes.", + usage => "||$usagemsg{objreturn}|", + example => "|Get all the vitails attributes for the node1.|GET|/nodes/node1/vitals|{\n \"node1\":{\n \"SysBrd Fault\":\"0\",\n \"CPUs\":\"0\",\n \"Fan 4A Tach\":\"3330 RPM\",\n \"Drive 15\":\"0\",\n \"SysBrd Vol Fault\":\"0\",\n \"nvDIMM Flash\":\"0\",\n \"Progress\":\"0\"\n ...\n }\n}|", + cmd => "rvitals", + fhandler => \&actionhdl, + outhdler => \&actionout, + }, + }, + vitalsattr => { + disable => 1, + desc => "[URI:/nodes/{noderange}/vitals/{temp|voltage|wattage|fanspeed|power|leds...}] - The specific vital attributes for the node {noderange}", + matcher => '^/nodes/[^/]*/vitals/\S+$', + GET => { + desc => "Get the specific vitals attibutes.", + usage => "||$usagemsg{objreturn}|", + example => "|Get the \'fanspeed\' vitals attribute.|GET|/nodes/node1/vitals/fanspeed|{\n \"node1\":{\n \"Fan 1A Tach\":\"3219 RPM\",\n \"Fan 4B Tach\":\"2688 RPM\",\n \"Fan 3B Tach\":\"2560 RPM\",\n \"Fan 4A Tach\":\"3330 RPM\",\n \"Fan 2A Tach\":\"3293 RPM\",\n \"Fan 1B Tach\":\"2592 RPM\",\n \"Fan 3A Tach\":\"3182 RPM\",\n \"Fan 2B Tach\":\"2592 RPM\"\n }\n}|", + cmd => "rvitals", + fhandler => \&actionhdl, + outhdler => \&actionout, + }, + }, + inventory => { + desc => "[URI:/nodes/{noderange}/inventory] - The inventory attributes for the node {noderange}", + matcher => '^/nodes/[^/]*/inventory$', + GET => { + desc => "Get all the inventory attibutes.", + usage => "||$usagemsg{objreturn}|", + example => "|Get all the inventory attributes for node1.|GET|/nodes/node1/inventory|{\n \"node1\":{\n \"DIMM 21 \":\"8GB PC3-12800 (1600 MT/s) ECC RDIMM\",\n \"DIMM 1 Manufacturer\":\"Hyundai Electronics\",\n \"Power Supply 2 Board FRU Number\":\"94Y8105\",\n \"DIMM 9 Model\":\"HMT31GR7EFR4C-PB\",\n \"DIMM 8 Manufacture Location\":\"01\",\n \"DIMM 13 Manufacturer\":\"Hyundai Electronics\",\n \"DASD Backplane 4\":\"Not Present\",\n ...\n }\n}|", + cmd => "rinv", + fhandler => \&actionhdl, + outhdler => \&actionout, + }, + }, + inventoryattr => { + desc => "[URI:/nodes/{noderange}/inventory/{pci|model...}] - The specific inventory attributes for the node {noderange}", + matcher => '^/nodes/[^/]*/inventory/\S+$', + GET => { + desc => "Get the specific inventory attibutes.", + usage => "||$usagemsg{objreturn}|", + example => "|Get the \'model\' inventory attribute for node1.|GET|/nodes/node1/inventory/model|{\n \"node1\":{\n \"System Description\":\"System x3650 M4\",\n \"System Model/MTM\":\"7915C2A\"\n }\n}|", + cmd => "rinv", + fhandler => \&actionhdl, + outhdler => \&actionout, + }, + }, + eventlog => { + desc => "[URI:/nodes/{noderange}/eventlog] - The eventlog resource for the node {noderange}", + matcher => '^/nodes/[^/]*/eventlog$', + GET => { + desc => "Get all the eventlog for the node {noderange}.", + usage => "||$usagemsg{objreturn}|", + example => "|Get all the eventlog for node1.|GET|/nodes/node1/eventlog|{\n \"node1\":{\n \"eventlog\":[\n \"03/19/2014 15:17:58 Event Logging Disabled, Log Area Reset/Cleared (SEL Fullness)\"\n ]\n }\n}|", + cmd => "reventlog", + fhandler => \&actionhdl, + outhdler => \&actionout, + }, + DELETE => { + desc => "Clean up the event log for the node {noderange}.", + usage => "||$usagemsg{non_getreturn}|", + example => "|Delete all the event log for node1.|DELETE|/nodes/node1/eventlog|[\n {\n \"eventlog\":[\n \"SEL cleared\"\n ],\n \"name\":\"node1\"\n }\n]|", + cmd => "reventlog", + fhandler => \&actionhdl, + outhdler => \&noout, + }, + }, + beacon => { + desc => "[URI:/nodes/{noderange}/beacon] - The beacon resource for the node {noderange}", + matcher => '^/nodes/[^/]*/beacon$', + GET_backup => { + desc => "Get the beacon status for the node {noderange}.", + cmd => "rbeacon", + fhandler => \&common, + }, + PUT => { + desc => "Change the beacon status for the node {noderange}.", + usage => "|$usagemsg{objchparam} DataBody: {action:on/off/blink}.|$usagemsg{non_getreturn}|", + example => "|Turn on the beacon.|PUT|/nodes/node1/beacon {\"action\":\"on\"}|[\n {\n \"name\":\"node1\",\n \"beacon\":\"on\"\n }\n]|", + cmd => "rbeacon", + fhandler => \&actionhdl, + outhdler => \&noout, + }, + }, + virtualization => { + desc => "[URI:/nodes/{noderange}/virtualization] - The virtualization resource for the node {noderange}", + matcher => '^/nodes/[^/]*/virtualization$', + GET => { + desc => "Get the vm status for the node {noderange}.", + cmd => "lsvm", + fhandler => \&common, + }, + PUT => { + desc => "Change the vm status for the node {noderange}. DataBody: {new:1|clone:1|migrate:1 ...}. new=1 means to run mkvm; clone=1 means to run rclone; migrate=1 means to run rmigrate.", + cmd => "", + fhandler => \&common, + }, + DELETE => { + desc => "Remove the vm node {noderange}.", + cmd => "rmvm", + fhandler => \&common, + }, + }, + updating => { + desc => "[URI:/nodes/{noderange}/updating] - The updating resource for the node {noderange}", + matcher => '^/nodes/[^/]*/updating$', + POST => { + desc => "Update the node with file syncing, software maintenance and rerun postscripts.", + usage => "||An array of messages for performing the node updating.|", + example => "|Initiate an updatenode process.|POST|/nodes/node2/updating|[\n \"There were no syncfiles defined to process. File synchronization has completed.\",\n \"Performing software maintenance operations. This could take a while, if there are packages to install.\n\",\n \"node2: Wed Mar 20 15:01:43 CST 2013 Running postscript: ospkgs\",\n \"node2: Running of postscripts has completed.\"\n]|", + cmd => "updatenode", + fhandler => \&actionhdl, + outhdler => \&infoout, + }, + }, + filesyncing => { + desc => "[URI:/nodes/{noderange}/filesyncing] - The filesyncing resource for the node {noderange}", + matcher => '^/nodes/[^/]*/filesyncing$', + POST => { + desc => "Sync files for the node {noderange}.", + usage => "||An array of messages for performing the file syncing for the node.|", + example => "|Initiate an file syncing process.|POST|/nodes/node2/filesyncing|[\n \"There were no syncfiles defined to process. File synchronization has completed.\"\n]|", + cmd => "updatenode", + fhandler => \&actionhdl, + outhdler => \&infoout, + }, + }, + software_maintenance => { + desc => "[URI:/nodes/{noderange}/sw] - The software maintenance for the node {noderange}", + matcher => '^/nodes/[^/]*/sw$', + POST => { + desc => "Perform the software maintenance process for the node {noderange}.", + usage => "||$usagemsg{objreturn}|", + example => "|Initiate an software maintenance process.|POST|/nodes/node2/sw|{\n \"node2\":[\n \" Wed Apr 3 09:05:42 CST 2013 Running postscript: ospkgs\",\n \" Unable to read consumer identity\",\n \" Postscript: ospkgs exited with code 0\",\n \" Wed Apr 3 09:05:44 CST 2013 Running postscript: otherpkgs\",\n \" ./otherpkgs: no extra rpms to install\",\n \" Postscript: otherpkgs exited with code 0\",\n \" Running of Software Maintenance has completed.\"\n ]\n}|", + cmd => "updatenode", + fhandler => \&actionhdl, + outhdler => \&infoout, + }, + }, + postscript => { + desc => "[URI:/nodes/{noderange}/postscript] - The postscript resource for the node {noderange}", + matcher => '^/nodes/[^/]*/postscript$', + POST => { + desc => "Run the postscripts for the node {noderange}.", + usage => "|$usagemsg{objchparam} DataBody: {scripts:[p1,p2,p3,...]}.|$usagemsg{objreturn}|", + example => "|Initiate an updatenode process.|POST|/nodes/node2/postscript {\"scripts\":[\"syslog\",\"remoteshell\"]}|{\n \"node2\":[\n \" Wed Apr 3 09:01:33 CST 2013 Running postscript: syslog\",\n \" Shutting down system logger: [ OK ]\",\n \" Starting system logger: [ OK ]\",\n \" Postscript: syslog exited with code 0\",\n \" Wed Apr 3 09:01:33 CST 2013 Running postscript: remoteshell\",\n \" Stopping sshd: [ OK ]\",\n \" Starting sshd: [ OK ]\",\n \" Postscript: remoteshell exited with code 0\",\n \" Running of postscripts has completed.\"\n ]\n}|", + cmd => "updatenode", + fhandler => \&actionhdl, + outhdler => \&infoout, + }, + }, + nodeshell => { + desc => "[URI:/nodes/{noderange}/nodeshell] - The nodeshell resource for the node {noderange}", + matcher => '^/nodes/[^/]*/nodeshell$', + POST => { + desc => "Run the command in the shell of the node {noderange}.", + usage => "|$usagemsg{objchparam} DataBody: {command:[cmd1,cmd2]}.|$usagemsg{objreturn}|", + example => "|Run the \'data\' command on the node2.|POST|/nodes/node2/nodeshell {\"command\":[\"date\",\"ls\"]}|{\n \"node2\":[\n \" Wed Apr 3 08:30:26 CST 2013\",\n \" testline1\",\n \" testline2\"\n ]\n}|", + cmd => "xdsh", + fhandler => \&actionhdl, + outhdler => \&infoout, + }, + }, + nodecopy => { + desc => "[URI:/nodes/{noderange}/nodecopy] - The nodecopy resource for the node {noderange}", + matcher => '^/nodes/[^/]*/nodecopy$', + POST => { + desc => "Copy files to the node {noderange}.", + usage => "|$usagemsg{objchparam} DataBody: {src:[file1,file2],target:dir}.|$usagemsg{non_getreturn}|", + example => "|Copy files /tmp/f1 and /tmp/f2 from xCAT MN to the node2:/tmp.|POST|/nodes/node2/nodecopy {\"src\":[\"/tmp/f1\",\"/tmp/f2\"],\"target\":\"/tmp\"}|no output for succeeded copy.|", + cmd => "xdcp", + fhandler => \&actionhdl, + outhdler => \&infoout, + }, + }, + subnodes => { + desc => "[URI:/nodes/{noderange}/subnodes] - The sub-nodes resources for the node {noderange}", + matcher => '^/nodes/[^/]*/subnodes$', + GET => { + desc => "Return the Children nodes for the node {noderange}.", + usage => "||$usagemsg{objreturn}|", + example => "|Get all the children nodes for node \'node1\'.|GET|/nodes/node1/subnodes|{\n \"cmm01node09\":{\n \"mpa\":\"ngpcmm01\",\n \"parent\":\"ngpcmm01\",\n \"serial\":\"1035CDB\",\n \"mtm\":\"789523X\",\n \"cons\":\"fsp\",\n \"hwtype\":\"blade\",\n \"objtype\":\"node\",\n \"groups\":\"blade,all,p260\",\n \"mgt\":\"fsp\",\n \"nodetype\":\"ppc,osi\",\n \"slotid\":\"9\",\n \"hcp\":\"10.1.9.9\",\n \"id\":\"1\"\n },\n ...\n}|", + cmd => "rscan", + fhandler => \&actionhdl, + outhdler => \&defout, + }, + # the put should be implemented by customer that using GET to get all the resources and define it with PUT /nodes/ + PUT_bak => { + desc => "Update the Children node for the node {noderange}.", + cmd => "rscan", + fhandler => \&common, + }, + }, + bootstate => { + desc => "[URI:/nodes/{noderange}/bootstate] - The boot state resource for node {noderange}.", + matcher => '^/nodes/[^/]*/bootstate$', + GET => { + desc => "Get boot state.", + usage => "||$usagemsg{objreturn}|", + example => "|Get the next boot state for the node1.|GET|/nodes/node1/bootstate|{\n \"node1\":{\n \"bootstat\":\"boot\"\n }\n}|", + cmd => "nodeset", + fhandler => \&actionhdl, + outhdler => \&actionout, + }, + PUT => { + desc => "Set the boot state.", + usage => "|$usagemsg{objchparam} DataBody: {osimage:xxx}/{state:offline}.|$usagemsg{non_getreturn}|", + example => "|Set the next boot state for the node1.|PUT|/nodes/node1/bootstate {\"osimage\":\"rhels6.4-x86_64-install-compute\"}||", + cmd => "nodeset", + fhandler => \&actionhdl, + outhdler => \&noout, + }, + }, + + + # TODO: rflash + }, + + #### definition for group resources + groups => { + all_groups => { + desc => "[URI:/groups] - The group list resource.", + desc1 => "This resource can be used to display all the groups which have been defined in the xCAT database.", + matcher => '^/groups$', + GET => { + desc => "Get all the groups in xCAT.", + desc1 => "The attributes details for the group will not be displayed.", + usage => "||Json format: An array of group names.|", + example => "|Get all the group names from xCAT database.|GET|/groups|[\n \"__mgmtnode\",\n \"all\",\n \"compute\",\n \"ipmi\",\n \"kvm\",\n]|", + cmd => "lsdef", + fhandler => \&defhdl, + outhdler => \&defout_remove_appended_type, + } + }, + group_allattr => { + desc => "[URI:/groups/{groupname}] - The group resource", + matcher => '^/groups/[^/]*$', + GET => { + desc => "Get all the attibutes for the group {groupname}.", + usage => "||$usagemsg{objreturn}|", + example => "|Get all the attibutes for group \'all\'.|GET|/groups/all|{\n \"all\":{\n \"members\":\"zxnode2,nodexxx,node1,node4\"\n }\n}|", + cmd => "lsdef", + fhandler => \&defhdl, + outhdler => \&defout, + }, + PUT => { + desc => "Change the attibutes for the group {groupname}.", + usage => "|$usagemsg{objchparam} DataBody: {attr1:v1,att2:v2,...}.|$usagemsg{non_getreturn}|", + example => "|Change the attributes mgt=dfm and netboot=yaboot.|PUT|/groups/all {\"mgt\":\"dfm\",\"netboot\":\"yaboot\"}||", + cmd => "chdef", + fhandler => \&defhdl, + outhdler => \&noout, + }, + }, + group_attr => { + desc => "[URI:/groups/{groupname}/attrs/{attr1,attr2,attr3 ...}] - The attributes resource for the group {groupname}", + matcher => '^/groups/[^/]*/attrs/\S+$', + GET => { + desc => "Get the specific attributes for the group {groupname}.", + usage => "||$usagemsg{objreturn}|", + example => "|Get the attributes {mgt,netboot} for group all|GET|/groups/all/attrs/mgt,netboot|{\n \"all\":{\n \"netboot\":\"yaboot\",\n \"mgt\":\"dfm\"\n }\n}|", + cmd => "lsdef", + fhandler => \&defhdl, + outhdler => \&defout, + }, + }, + }, + + #### definition for services resources: dns, dhcp, hostname + services => { + host => { + desc => "[URI:/services/host] - The hostname resource.", + matcher => '^/services/host$', + POST => { + desc => "Create the ip/hostname records for all the nodes to /etc/hosts.", + usage => "||$usagemsg{non_getreturn}|", + example => "|Create the ip/hostname records for all the nodes to /etc/hosts.|POST|/services/host||", + cmd => "makehosts", + fhandler => \&nonobjhdl, + outhdler => \&noout, + } + }, + dns => { + desc => "[URI:/services/dns] - The dns service resource.", + matcher => '^/services/dns$', + POST => { + desc => "Initialize the dns service.", + usage => "||$usagemsg{non_getreturn}|", + example => "|Initialize the dns service.|POST|/services/dns||", + cmd => "makedns", + fhandler => \&nonobjhdl, + outhdler => \&noout, + } + }, + dhcp => { + desc => "[URI:/services/dhcp] - The dhcp service resource.", + matcher => '^/services/dhcp$', + POST => { + desc => "Create the dhcpd.conf for all the networks which are defined in the xCAT Management Node.", + usage => "||$usagemsg{non_getreturn}|", + example => "|Create the dhcpd.conf and restart the dhcpd.|POST|/services/dhcp||", + cmd => "makedhcp", + fhandler => \&nonobjhdl, + outhdler => \&noout, + } + }, + # todo: for slpnode, we need use the query attribute to specify the network parameter for lsslp command + slpnodes => { + desc => "[URI:/services/slpnodes] - The nodes which support SLP in the xCAT cluster", + matcher => '^/services/slpnodes', + GET => { + desc => "Get all the nodes which support slp protocol in the network.", + usage => "||$usagemsg{objreturn}|", + example => "|Get all the nodes which support slp in the network.|GET|/services/slpnodes|{\n \"ngpcmm01\":{\n \"mpa\":\"ngpcmm01\",\n \"otherinterfaces\":\"10.1.9.101\",\n \"serial\":\"100037A\",\n \"mtm\":\"789392X\",\n \"hwtype\":\"cmm\",\n \"side\":\"2\",\n \"objtype\":\"node\",\n \"nodetype\":\"mp\",\n \"groups\":\"cmm,all,cmm-zet\",\n \"mgt\":\"blade\",\n \"hidden\":\"0\",\n \"mac\":\"5c:f3:fc:25:da:99\"\n },\n ...\n}|", + cmd => "lsslp", + fhandler => \&nonobjhdl, + outhdler => \&defout, + }, + PUT_bakcup => { + desc => "Update the discovered nodes to database.", + cmd => "lsslp", + fhandler => \&common, + }, + }, + specific_slpnodes => { + desc => "[URI:/services/slpnodes/{CEC|FRAME|MM|IVM|RSA|HMC|CMM|IMM2|FSP...}] - The slp nodes with specific service type in the xCAT cluster", + matcher => '^/services/slpnodes/[^/]*$', + GET => { + desc => "Get all the nodes with specific slp service type in the network.", + usage => "||$usagemsg{objreturn}|", + example => "|Get all the CMM nodes which support slp in the network.|GET|/services/slpnodes/CMM|{\n \"ngpcmm01\":{\n \"mpa\":\"ngpcmm01\",\n \"otherinterfaces\":\"10.1.9.101\",\n \"serial\":\"100037A\",\n \"mtm\":\"789392X\",\n \"hwtype\":\"cmm\",\n \"side\":\"2\",\n \"objtype\":\"node\",\n \"nodetype\":\"mp\",\n \"groups\":\"cmm,all,cmm-zet\",\n \"mgt\":\"blade\",\n \"hidden\":\"0\",\n \"mac\":\"5c:f3:fc:25:da:99\"\n },\n \"Server--SNY014BG27A01K\":{\n \"mpa\":\"Server--SNY014BG27A01K\",\n \"otherinterfaces\":\"10.1.9.106\",\n \"serial\":\"100CF0A\",\n \"mtm\":\"789392X\",\n \"hwtype\":\"cmm\",\n \"side\":\"1\",\n \"objtype\":\"node\",\n \"nodetype\":\"mp\",\n \"groups\":\"cmm,all,cmm-zet\",\n \"mgt\":\"blade\",\n \"hidden\":\"0\",\n \"mac\":\"34:40:b5:df:0a:be\"\n }\n}|", + cmd => "lsslp", + fhandler => \&nonobjhdl, + outhdler => \&defout, + }, + PUT_backup => { + desc => "Update the discovered nodes to database.", + cmd => "lsslp", + fhandler => \&common, + }, + }, + }, + + #### definition for network resources + networks => { + allnetwork => { + desc => "[URI:/networks] - The network list resource.", + desc1 => "This resource can be used to display all the networks which have been defined in the xCAT database.", + matcher => '^\/networks$', + GET => { + desc => "Get all the networks in xCAT.", + desc1 => "The attributes details for the networks will not be displayed.", + usage => "||Json format: An array of networks names.|", + example => "|Get all the networks names from xCAT database.|GET|/networks|[\n \"network1\",\n \"network2\",\n \"network3\",\n]|", + cmd => "lsdef", + fhandler => \&defhdl, + outhdler => \&defout_remove_appended_type, + }, + POST => { + desc => "Create the networks resources base on the network configuration on xCAT MN.", + usage => "|$usagemsg{objchparam} DataBody: {attr1:v1,att2:v2,...}.|$usagemsg{non_getreturn}|", + example => "|Create the networks resources base on the network configuration on xCAT MN.|POST|/networks||", + cmd => "makenetworks", + fhandler => \&actionhdl, + }, + }, + network_allattr => { + desc => "[URI:/networks/{netname}] - The network resource", + matcher => '^\/networks\/[^\/]*$', + GET => { + desc => "Get all the attibutes for the network {netname}.", + usage => "||$usagemsg{objreturn}|", + example => "|Get all the attibutes for network \'network1\'.|GET|/networks/network1|{\n \"network1\":{\n \"gateway\":\"\",\n \"mask\":\"255.255.255.0\",\n \"mgtifname\":\"eth2\",\n \"net\":\"10.0.0.0\",\n \"tftpserver\":\"10.0.0.119\",\n ...\n }\n}|", + cmd => "lsdef", + fhandler => \&defhdl, + outhdler => \&defout, + }, + PUT => { + desc => "Change the attibutes for the network {netname}.", + usage => "|$usagemsg{objchparam} DataBody: {attr1:v1,att2:v2,...}.|$usagemsg{non_getreturn}|", + example => "|Change the attributes mgtifname=eth0 and net=10.1.0.0.|PUT|/networks/network1 {\"mgtifname\":\"eth0\",\"net\":\"10.1.0.0\"}||", + cmd => "chdef", + fhandler => \&defhdl, + outhdler => \&noout, + }, + POST => { + desc => "Create the network {netname}. DataBody: {attr1:v1,att2:v2...}.", + usage => "|$usagemsg{objchparam} DataBody: {attr1:v1,att2:v2,...}.|$usagemsg{non_getreturn}|", + example => "|Create a network with attributes gateway=10.1.0.1, mask=255.255.0.0 |POST|/networks/network1 {\"gateway\":\"10.1.0.1\",\"mask\":\"255.255.0.0\"}||", + cmd => "mkdef", + fhandler => \&defhdl, + outhdler => \&noout, + }, + DELETE => { + desc => "Remove the network {netname}.", + usage => "||$usagemsg{non_getreturn}|", + example => "|Delete the network network1|DELETE|/networks/network1||", + cmd => "rmdef", + fhandler => \&defhdl, + outhdler => \&noout + }, + }, + network_attr => { + desc => "[URI:/networks/{netname}/attrs/attr1,attr2,...] - The attributes resource for the network {netname}", + matcher => '^\/networks\/[^\/]*/attrs/\S+$', + GET => { + desc => "Get the specific attributes for the network {netname}.", + usage => "||$usagemsg{objreturn}|", + example => "|Get the attributes {groups,mgt,netboot} for network network1|GET|/networks/network1/attrs/gateway,mask,mgtifname,net,tftpserver|{\n \"network1\":{\n \"gateway\":\"9.114.34.254\",\n \"mask\":\"255.255.255.0\",\n }\n}|", + cmd => "lsdef", + fhandler => \&defhdl, + outhdler => \&defout, + }, + PUT__backup => { + desc => "Change attributes for the network {netname}. DataBody: {attr1:v1,att2:v2,att3:v3 ...}.", + usage => "||An array of network objects.|", + example => "|Get the attributes {gateway,mask,mgtifname,net,tftpserver} for networks network1|GET|/networks/network1/attrs/gateway;mask;net||", + cmd => "chdef", + fhandler => \&noout, + } + }, + + }, + + #### definition for osimage resources + osimages => { + osimage => { + desc => "[URI:/osimages] - The osimage resource.", + matcher => '^\/osimages$', + GET => { + desc => "Get all the osimage in xCAT.", + usage => "||Json format: An array of osimage names.|", + example => "|Get all the osimage names.|GET|/osimages|[\n \"sles11.2-x86_64-install-compute\",\n \"sles11.2-x86_64-install-iscsi\",\n \"sles11.2-x86_64-install-iscsiibft\",\n \"sles11.2-x86_64-install-service\"\n]|", + + cmd => "lsdef", + fhandler => \&defhdl, + outhdler => \&defout_remove_appended_type, + }, + POST => { + desc => "Create the osimage resources base on the parameters specified in the Data body.", + #usage => "|$usagemsg{objchparam} DataBody: {iso:isoname\\file:filename\\node:noderange,params:[{attr1:value1,attr2:value2}]}|$usagemsg{non_getreturn}|", + usage => "|$usagemsg{objchparam} DataBody: {iso:isoname\\file:filename,params:[{attr1:value1,attr2:value2}]}|$usagemsg{non_getreturn}|", + example1 => "|Create osimage resources based on the ISO specified|POST|/osimages {\"iso\":\"/iso/RHEL6.4-20130130.0-Server-ppc64-DVD1.iso\"}||", + example2 => "|Create osimage resources based on an xCAT image or configuration file|POST|/osimages {\"file\":\"/tmp/sles11.2-x86_64-install-compute.tgz\"}||", + # TD: the imgcapture need to be moved to nodes/.*/osimages + # example3 => "|Create a image based on the specified Linux diskful node|POST|/osimages {\"node\":\"rhcn1\"}||", + cmd => "copycds", + fhandler => \&imgophdl, + outhdler => \&noout, + }, + }, + osimage_allattr => { + desc => "[URI:/osimages/{imgname}] - The osimage resource", + matcher => '^\/osimages\/[^\/]*$', + GET => { + desc => "Get all the attibutes for the osimage {imgname}.", + usage => "||$usagemsg{objreturn}|", + example => "|Get the attributes for the specified osimage.|GET|/osimages/sles11.2-x86_64-install-compute|{\n \"sles11.2-x86_64-install-compute\":{\n \"provmethod\":\"install\",\n \"profile\":\"compute\",\n \"template\":\"/opt/xcat/share/xcat/install/sles/compute.sles11.tmpl\",\n \"pkglist\":\"/opt/xcat/share/xcat/install/sles/compute.sles11.pkglist\",\n \"osvers\":\"sles11.2\",\n \"osarch\":\"x86_64\",\n \"osname\":\"Linux\",\n \"imagetype\":\"linux\",\n \"otherpkgdir\":\"/install/post/otherpkgs/sles11.2/x86_64\",\n \"osdistroname\":\"sles11.2-x86_64\",\n \"pkgdir\":\"/install/sles11.2/x86_64\"\n }\n}|", + cmd => "lsdef", + fhandler => \&defhdl, + outhdler => \&defout, + }, + + POST => { + desc => "Create the osimage {imgname}.", + usage => "|$usagemsg{objchparam} DataBody: {attr1:v1,attr2:v2]|$usagemsg{non_getreturn}|", + example => "|Create a osimage obj with the specified parameters.|POST|/osimages/sles11.3-ppc64-install-compute {\"osvers\":\"sles11.3\",\"osarch\":\"ppc64\",\"osname\":\"Linux\",\"provmethod\":\"install\",\"profile\":\"compute\"}||", + cmd => "mkdef", + fhandler => \&defhdl, + outhdler => \&noout, + }, + PUT => { + desc => "Change the attibutes for the osimage {imgname}.", + usage => "|$usagemsg{objchparam} DataBody: {attr1:v1,attr2:v2...}|$usagemsg{non_getreturn}|", + example => "|Change the 'osvers' and 'osarch' attributes for the osiamge.|PUT|/osimages/sles11.2-ppc64-install-compute/ {\"osvers\":\"sles11.3\",\"osarch\":\"x86_64\"}||", + cmd => "chdef", + fhandler => \&defhdl, + outhdler => \&noout, + }, + DELETE => { + desc => "Remove the osimage {imgname}.", + usage => "||$usagemsg{non_getreturn}|", + example => "|Delete the specified osimage.|DELETE|/osimages/sles11.3-ppc64-install-compute||", + cmd => "rmdef", + fhandler => \&defhdl, + outhdler => \&noout, + }, + }, + osimage_attr => { + desc => "[URI:/osimages/{imgname}/attrs/attr1,attr2,attr3 ...] - The attributes resource for the osimage {imgname}", + matcher => '^\/osimages\/[^\/]*/attrs/\S+$', + GET => { + desc => "Get the specific attributes for the osimage {imgname}.", + usage => "||Json format: An array of attr:value pairs for the specified osimage.|", + example => "|Get the specified attributes.|GET|/osimages/sles11.2-ppc64-install-compute/attrs/imagetype,osarch,osname,provmethod|{\n \"sles11.2-ppc64-install-compute\":{\n \"provmethod\":\"install\",\n \"osname\":\"Linux\",\n \"osarch\":\"ppc64\",\n \"imagetype\":\"linux\"\n }\n}|", + cmd => "lsdef", + fhandler => \&defhdl, + outhdler => \&defout, + }, + # TD, the implementation may need to be change. + PUT_backup => { + desc => "Change the attibutes for the osimage {imgname}.", + usage => "|$usagemsg{objchparam} DataBody: {attr1:v1,attr2:v2...}|$usagemsg{non_getreturn}|", + example => "|Change the 'osvers' and 'osarch' attributes for the osiamge.|PUT|/osimages/sles11.2-ppc64-install-compute/attrs/osvers;osarch {\"osvers\":\"sles11.3\",\"osarch\":\"x86_64\"}||", + cmd => "chdef", + fhandler => \&defhdl, + outhdler => \&noout, + }, + + }, + osimage_op => { + desc => "[URI:/osimages/{imgname}/instance] - The instance for the osimage {imgname}", + matcher => '^\/osimages\/[^\/]*/instance$', + POST => { + desc => "Operate the instance of the osimage {imgname}.", + usage => "|$usagemsg{objchparam} DataBody: {action:gen\\pack\\export,params:[{attr1:value1,attr2:value2...}]}|$usagemsg{non_getreturn}|", + example1 => "|Generates a stateless image based on the specified osimage|POST|/osimages/sles11.2-x86_64-install-compute/instance {\"action\":\"gen\"}||", + example2 => "|Packs the stateless image from the chroot file system based on the specified osimage|POST|/osimages/sles11.2-x86_64-install-compute/instance {\"action\":\"pack\"}||", + example3 => "|Exports an xCAT image based on the specified osimage|POST|/osimages/sles11.2-x86_64-install-compute/instance {\"action\":\"export\"}||", + cmd => "", + fhandler => \&imgophdl, + }, + DELETE => { + desc => "Delete the stateless or statelite image instance for the osimage {imgname} from the file system", + usage => "||$usagemsg{non_getreturn}", + example => "|Delete the stateless image for the specified osimage|DELETE|/osimages/sles11.2-x86_64-install-compute/instance||", + cmd => "rmimage", + fhandler => \&imgophdl, + }, + }, + + # todo: genimage, packimage, imagecapture, imgexport, imgimport + }, + + #### definition for policy resources + policy => { + policy => { + desc => "[URI:/policy] - The policy resource.", + matcher => '^\/policy$', + GET => { + desc => "Get all the policies in xCAT.", + desc1 => "It will dislplay all the policy resource.", + usage => "||$usagemsg{objreturn}|", + example => "|Get all the policy objects.|GET|/policy|[\n \"1\",\n \"1.2\",\n \"2\",\n \"4.8\"\n]|", + cmd => "lsdef", + fhandler => \&defhdl, + outhdler => \&defout_remove_appended_type, + }, + }, + policy_allattr => { + desc => "[URI:/policy/{policy_priority}] - The policy resource", + matcher => '^\/policy\/[^\/]*$', + GET => { + desc => "Get all the attibutes for a policy {policy_priority}.", + desc1 => "It will display all the policy attributes for one policy resource.", + usage => "||$usagemsg{objreturn}|", + example => "|Get all the attribute for policy 1.|GET|/policy/1|{\n \"1\":{\n \"name\":\"root\",\n \"rule\":\"allow\"\n }\n}|", + cmd => "lsdef", + fhandler => \&defhdl, + outhdler => \&defout, + }, + PUT => { + desc => "Change the attibutes for the policy {policy_priority}.", + desc1 => "It will change one or more attributes for a policy.", + usage => "|$usagemsg{objchparam} DataBody: {attr1:v1,att2:v2,...}.|$usagemsg{non_getreturn}|", + example => "|Set the name attribute for policy 3.|PUT|/policy/3 {\"name\":\"root\"}||", + cmd => "chdef", + fhandler => \&defhdl, + outhdler => \&noout, + }, + POST => { + desc => "Create the policy {policyname}. DataBody: {attr1:v1,att2:v2...}.", + desc1 => "It will creat a new policy resource.", + usage => "|$usagemsg{objchparam} DataBody: {attr1:v1,att2:v2,...}.|$usagemsg{non_getreturn}|", + example => "|Create a new policy 10.|POST|/policy/10 {\"name\":\"root\",\"commands\":\"rpower\"}||", + cmd => "chdef", + fhandler => \&defhdl, + outhdler => \&noout, + }, + DELETE => { + desc => "Remove the policy {policy_priority}.", + desc1 => "Remove one or more policy resource.", + usage => "||$usagemsg{non_getreturn}|", + example => "|Delete the policy 10.|DELETE|/policy/10||", + cmd => "rmdef", + fhandler => \&defhdl, + outhdler => \&noout, + }, + }, + policy_attr => { + desc => "[URI:/policy/{policyname}/attrs/{attr1,attr2,attr3,...}] - The attributes resource for the policy {policy_priority}", + matcher => '^\/policy\/[^\/]*/attrs/\S+$', + GET => { + desc => "Get the specific attributes for the policy {policy_priority}.", + desc1 => "It will get one or more attributes of a policy.", + usage => "||$usagemsg{objreturn}|", + example => "|Get the name and rule attributes for policy 1.|GET|/policy/1/attrs/name,rule|{\n \"1\":{\n \"name\":\"root\",\n \"rule\":\"allow\"\n }\n}|", + cmd => "lsdef", + fhandler => \&defhdl, + outhdler => \&defout, + }, + }, + }, + #### definition for global setting resources + globalconf => { + all_site => { + desc => "[URI:/globalconf] - The global configuration resource.", + desc1 => "This resource can be used to display all the global configuration which have been defined in the xCAT database.", + matcher => '^\/globalconf$', + GET => { + desc => "Get all the xCAT global configuration.", + desc1=> "It will display all the global attributes.", + usage => "||$usagemsg{objreturn}|", + example => "|Get all the global configuration|GET|/globalconf|{\n \"clustersite\":{\n \"xcatconfdir\":\"/etc/xcat\",\n \"tftpdir\":\"/tftpboot\",\n ...\n }\n}|", + cmd => "lsdef", + fhandler => \&sitehdl, + outhdler => \&defout, + }, + POST_backup => { + desc => "Add the site attributes. DataBody: {attr1:v1,att2:v2...}.", + desc1 => "One or more global attributes could be added/modified.", + usage => "|$usagemsg{objchparam} DataBody: {attr1:v1,att2:v2,...}.|$usagemsg{non_getreturn}|", + example => "|Add one or more attributes to xCAT database|POST|/globalconf {\"domain\":\"cluster.com\",\"mydomain\":\"mycluster.com\"}||", + cmd => "chdef", + fhandler => \&sitehdl, + }, + }, + site => { + desc => "[URI:/globalconf/attrs/{attr1,attr2 ...}] - The specific global configuration resource.", + matcher => '^\/globalconf/attrs/\S+$', + GET => { + desc => "Get the specific configuration in global.", + desc1 => "It will display one or more global attributes.", + usage => "||$usagemsg{objreturn}|", + example => "|Get the \'master\' and \'domain\' configuration.|GET|/globalconf/attrs/master,domain|{\n \"clustersite\":{\n \"domain\":\"cluster.com\",\n \"master\":\"192.168.1.15\"\n }\n}|", + cmd => "lsdef", + fhandler => \&sitehdl, + outhdler => \&defout, + }, + PUT => { + desc => "Change the global attributes.", + desc1 => "It can be used for changing/adding global attributes.", + usage => "|$usagemsg{objchparam} DataBody: {attr1:v1,att2:v2,...}.|$usagemsg{non_getreturn}|", + example => "|Change/Add the domain attribute.|PUT|/globalconf/attrs/domain {\"domain\":\"cluster.com\"}||", + cmd => "chdef", + fhandler => \&sitehdl, + outhdler => \&noout, + }, + POST_backup => { + desc => "Create the global configuration entry. DataBody: {name:value}.", + usage => "||$usagemsg{non_getreturn}|", + example => "|Create the domain attribute|POST|/globalconf/attrs/domain {\"domain\":\"cluster.com\"}|?|", + cmd => "chdef", + fhandler => \&sitehdl, + outhdler => \&noout, + }, + DELETE => { + desc => "Remove the site attributes.", + desc1 => "Used for femove one or more global attributes.", + usage => "||$usagemsg{non_getreturn}|", + example => "|Remove the domain configure.|DELETE|/globalconf/attrs/domain||", + cmd => "chdef", + fhandler => \&sitehdl, + outhdler => \&noout, + }, + }, + }, + + #### definition for database/table resources + tables => { + table_nodes => { + desc => "[URI:/tables/{tablelist}/nodes/{noderange}] - The node table resource", + desc1 => "For a large number of nodes, this API call can be faster than using the corresponding nodes resource. The disadvantage is that you need to know the table names the attributes are stored in.", + matcher => '^/tables/[^/]+/nodes/[^/]+$', + GET => { + desc => "Get attibutes of tables for a noderange.", + usage => "||An object containing each table. Within each table object is an array of node objects containing the attributes.|", + example1 => qq(|Get all the columns from table nodetype for node1 and node2.|GET|/tables/nodetype/nodes/node1,node2|{\n \"nodetype\":[\n {\n \"provmethod\":\"rhels6.4-x86_64-install-compute\",\n \"profile\":\"compute\",\n \"arch\":\"x86_64\",\n \"name\":\"node1\",\n \"os\":\"rhels6.4\"\n },\n {\n \"provmethod\":\"rhels6.3-x86_64-install-compute\",\n \"profile\":\"compute\",\n \"arch\":\"x86_64\",\n \"name\":\"node2\",\n \"os\":\"rhels6.3\"\n }\n ]\n}|), + example2 => qq(|Get all the columns from tables nodetype and noderes for node1 and node2.|GET|/tables/nodetype,noderes/nodes/node1,node2|{\n \"noderes\":[\n {\n \"installnic\":\"mac\",\n \"netboot\":\"xnba\",\n \"name\":\"node1\",\n \"nfsserver\":\"192.168.1.15\"\n },\n {\n \"installnic\":\"mac\",\n \"netboot\":\"pxe\",\n \"name\":\"node2\",\n \"proxydhcp\":\"no\"\n }\n ],\n \"nodetype\":[\n {\n \"provmethod\":\"rhels6.4-x86_64-install-compute\",\n \"profile\":\"compute\",\n \"arch\":\"x86_64\",\n \"name\":\"node1\",\n \"os\":\"rhels6.4\"\n },\n {\n \"provmethod\":\"rhels6.3-x86_64-install-compute\",\n \"profile\":\"compute\",\n \"arch\":\"x86_64\",\n \"name\":\"node2\",\n \"os\":\"rhels6.3\"\n }\n ]\n}|), + fhandler => \&tablenodehdl, + outhdler => \&tableout, + }, + PUT => { + desc => "Change the node table attibutes for {noderange}.", + usage => "|A hash of table names and attribute objects. DataBody: {table1:{attr1:v1,att2:v2,...}}.|$usagemsg{non_getreturn}|", + example => '|Change the nodetype.arch and noderes.netboot attributes for nodes node1,node2.|PUT|/tables/nodetype,noderes/nodes/node1,node2 {"nodetype":{"arch":"x86_64"},"noderes":{"netboot":"xnba"}}||', + fhandler => \&tablenodeputhdl, + outhdler => \&noout, + }, + }, + table_nodes_attrs => { + desc => "[URI:/tables/{tablelist}/nodes/nodes/{noderange}/{attrlist}] - The node table attributes resource", + desc1 => "For a large number of nodes, this API call can be faster than using the corresponding nodes resource. The disadvantage is that you need to know the table names the attributes are stored in.", + matcher => '^/tables/[^/]+/nodes/[^/]+/[^/]+$', + GET => { + desc => "Get table attibutes for a noderange.", + usage => "||An object containing each table. Within each table object is an array of node objects containing the attributes.|", + example => qq(|Get OS and ARCH attributes from nodetype table for node1 and node2.|GET|/tables/nodetype/nodes/node1,node2/os,arch|{\n \"nodetype\":[\n {\n \"arch\":\"x86_64\",\n \"name\":\"node1\",\n \"os\":\"rhels6.4\"\n },\n {\n \"arch\":\"x86_64\",\n \"name\":\"node2\",\n \"os\":\"rhels6.3\"\n }\n ]\n}|), + fhandler => \&tablenodehdl, + outhdler => \&tableout, + }, + PUT_backup => { + desc => "[URI:/tables/nodes/{noderange}] - Change the node table attibutes for the {noderange}.", + usage => "|A hash of table names and attribute objects. DataBody: {table1:{attr1:v1,att2:v2,...}}.|$usagemsg{non_getreturn}|", + example => '|Change the nodehm.mgmt and noderes.netboot attributes for nodes node1-node5.|PUT|/tables/nodes/node1-node5 {"nodehm":{"mgmt":"ipmi"},"noderes":{"netboot":"xnba"}}||', + fhandler => \&tablenodeputhdl, + outhdler => \&noout, + }, + }, + table_all_rows => { + desc => "[URI:/tables/{tablelist}/rows] - The non-node table resource", + desc1 => "Use this for tables that don't have node name as the key of the table, for example: passwd, site, networks, polciy, etc.", + matcher => '^/tables/[^/]+/rows$', + GET => { + desc => "Get all rows from non-node tables.", + usage => "||An object containing each table. Within each table object is an array of row objects containing the attributes.|", + example => qq(|Get all rows from networks table.|GET|/tables/networks/rows|{\n \"networks\":[\n {\n \"netname\":\"192_168_13_0-255_255_255_0\",\n \"gateway\":\"192.168.13.254\",\n \"staticrangeincrement\":\"1\",\n \"net\":\"192.168.13.0\",\n \"mask\":\"255.255.255.0\"\n },\n {\n \"netname\":\"192_168_12_0-255_255_255_0\",\n \"gateway\":\"192.168.12.254\",\n \"staticrangeincrement\":\"1\",\n \"net\":\"192.168.12.0\",\n \"mask\":\"255.255.255.0\"\n },\n ]\n}|), + fhandler => \&tablerowhdl, + outhdler => \&tableout, + }, + }, + table_rows => { + desc => "[URI:/tables/{tablelist}/rows/{keys}] - The non-node table rows resource", + desc1 => "Use this for tables that don't have node name as the key of the table, for example: passwd, site, networks, polciy, etc.", + desc2 => "{keys} should be the name=value pairs which are used to search table. e.g. {keys} should be [net=192.168.1.0,mask=255.255.255.0] for networks table query since the net and mask are the keys of networks table.", + matcher => '^/tables/[^/]+/rows/[^/]+$', + GET => { + desc => "Get attibutes for rows from non-node tables.", + usage => "||An object containing each table. Within each table object is an array of row objects containing the attributes.|", + example => qq(|Get row which net=192.168.1.0,mask=255.255.255.0 from networks table.|GET|/tables/networks/rows/net=192.168.1.0,mask=255.255.255.0|{\n \"networks\":[\n {\n \"mgtifname\":\"eth0\",\n \"netname\":\"192_168_1_0-255_255_255_0\",\n \"tftpserver\":\"192.168.1.15\",\n \"gateway\":\"192.168.1.100\",\n \"staticrangeincrement\":\"1\",\n \"net\":\"192.168.1.0\",\n \"mask\":\"255.255.255.0\"\n }\n ]\n}|), + fhandler => \&tablerowhdl, + outhdler => \&tableout, + }, + PUT => { + desc => "Change the non-node table attibutes for the row that matches the {keys}.", + usage => "|A hash of attribute names and values. DataBody: {attr1:v1,att2:v2,...}.|$usagemsg{non_getreturn}|", + example => '|Create a route row in the routes table.|PUT|/tables/routes/rows/routename=privnet {"net":"10.0.1.0","mask":"255.255.255.0","gateway":"10.0.1.254","ifname":"eth1"}||', + fhandler => \&tablerowputhdl, + outhdler => \&noout, + }, + DELETE => { + desc => "Delete rows from a non-node table that have the attribute values specified in {keys}.", + usage => "||$usagemsg{non_getreturn}|", + example => '|Delete a route row which routename=privnet in the routes table.|DELETE|/tables/routes/rows/routename=privnet||', + fhandler => \&tablerowdelhdl, + outhdler => \&noout, + }, + }, + table_rows_attrs => { + desc => "[URI:/tables/{tablelist}/rows/{keys}/{attrlist}] - The non-node table attributes resource", + desc1 => "Use this for tables that don't have node name as the key of the table, for example: passwd, site, networks, polciy, etc.", + matcher => '^/tables/[^/]+/rows/[^/]+/[^/]+$', + GET => { + desc => "Get specific attibutes for rows from non-node tables.", + usage => "||An object containing each table. Within each table object is an array of row objects containing the attributes.|", + example => qq(|Get attributes mgtifname and tftpserver which net=192.168.1.0,mask=255.255.255.0 from networks table.|GET|/tables/networks/rows/net=192.168.1.0,mask=255.255.255.0/mgtifname,tftpserver|{\n \"networks\":[\n {\n \"mgtifname\":\"eth0\",\n \"tftpserver\":\"192.168.1.15\"\n }\n ]\n}|), + fhandler => \&tablerowhdl, + outhdler => \&tableout, + }, + }, + }, + + #### definition for tokens resources + tokens => { + tokens => { + desc => "[URI:/tokens] - The authentication token resource.", + matcher => '^\/tokens', + POST => { + desc => "Create a token.", + usage => "||An array of all the global configuration list.|", + example => "|Aquire a token for user \'root\'.|POST|/tokens {\"userName\":\"root\",\"password\":\"cluster\"}|{\n \"token\":{\n \"id\":\"a6e89b59-2b23-429a-b3fe-d16807dd19eb\",\n \"expire\":\"2014-3-8 14:55:0\"\n }\n}|", + fhandler => \&nonobjhdl, + outhdler => \&tokenout, + }, + POST_backup => { + desc => "Add the site attributes. DataBody: {attr1:v1,att2:v2...}.", + usage => "|?|?|", + example => "|?|?|?|?|", + cmd => "chdef", + fhandler => \&sitehdl, + }, + }, + }, +); + +# supported formats +my %formatters = ( + 'json' => \&wrapJson, + #'html' => \&wrapHtml, + #'xml' => \&wrapXml +); + +# error status codes +my $STATUS_BAD_REQUEST = "400 Bad Request"; +my $STATUS_UNAUTH = "401 Unauthorized"; +my $STATUS_FORBIDDEN = "403 Forbidden"; +my $STATUS_NOT_FOUND = "404 Not Found"; +my $STATUS_NOT_ALLOWED = "405 Method Not Allowed"; +my $STATUS_NOT_ACCEPTABLE = "406 Not Acceptable"; +my $STATUS_TIMEOUT = "408 Request Timeout"; +my $STATUS_EXPECT_FAILED = "417 Expectation Failed"; +my $STATUS_TEAPOT = "418 I'm a teapot"; +my $STATUS_SERVICE_UNAVAILABLE = "503 Service Unavailable"; + +# good status codes +my $STATUS_OK = "200 OK"; +my $STATUS_CREATED = "201 Created"; # Development notes: # - added this line to /etc/httpd/conf/httpd.conf to hide the cgi-bin and .cgi extension in the uri: @@ -32,1975 +1145,1359 @@ use xCAT::Table; # print $q->end_html; #todo: add the tags # $q->url_param() # gets url options, even when there is put/post data (unlike q->param) -my $VERSION = "2.8"; + +#### Main procedure to handle the REST request + +# To get the HTTP elements through perl CGI module my $q = CGI->new; -#my $url = $q->url; # the 1st part of the url, https, hostname, port num, and /xcatws my $pathInfo = $q->path_info; # the resource specification, i.e. everything in the url after xcatws my $requestType = $q->request_method(); # GET, PUT, POST, PATCH, DELETE my $userAgent = $q->user_agent(); # the client program: curl, etc. -my @path = split(/\//, $pathInfo); -shift(@path); # get rid of the initial / -my $resource = $path[0]; -my $pageContent = ''; # global var containing the ouptut back to the rest client -my $request = {clienttype => 'ws'}; # global var that holds the request to send to xcatd +my @path = split(/\//, $pathInfo); # The uri path like /nodes/node1/... -#error status codes -my $STATUS_BAD_REQUEST = "400 Bad Request"; -my $STATUS_UNAUTH = "401 Unauthorized"; -my $STATUS_FORBIDDEN = "403 Forbidden"; -my $STATUS_NOT_FOUND = "404 Not Found"; -my $STATUS_NOT_ALLOWED = "405 Method Not Allowed"; -my $STATUS_NOT_ACCEPTABLE = "406 Not Acceptable"; -my $STATUS_TIMEOUT = "408 Request Timeout"; -my $STATUS_EXPECT_FAILED = "417 Expectation Failed"; -my $STATUS_TEAPOT = "418 I'm a teapot"; -my $STATUS_SERVICE_UNAVAILABLE = "503 Service Unavailable"; +# Define the golbal variables which will be used through the handling process +my $pageContent = ''; # Global var containing the ouptut back to the rest client +my $request = {clienttype => 'ws'}; # Global var that holds the request to send to xcatd +my $format = 'json'; # The output format for a request invoke +my $xmlinstalled; # Global var to speicfy whether the xml modules have been loaded -#good status codes -my $STATUS_OK = "200 OK"; -my $STATUS_CREATED = "201 Created"; +# To easy the perl debug, this script can be run directly with 'perl -d' +# This script also support to generate the rest api doc automatically. +# Following part of code will not be run when this script is called by http server +my $dbgdata; +sub dbgusage { print "Usage:\n $0 -h\n $0 -g [wiki] (generate document)\n $0 {GET|PUT|POST|DELETE} URI user:password \'{data}\'\n"; } -my $XCAT_PATH = '/opt/xcat/bin'; +if ($ARGV[0] eq "-h") { + dbgusage(); + exit 0; +} elsif ($ARGV[0] eq "-g") { + # generate the document + require genrestapidoc; + if (defined ($ARGV[1])) { + genrestapidoc::gendoc(\%URIdef, $ARGV[1]); + } else { + genrestapidoc::gendoc(\%URIdef); + } + exit 0; +} elsif ($ARGV[0] eq "-d") { + displayUsage(); + exit 0; +} elsif ($ARGV[0] =~ /(GET|PUT|POST|DELETE)/) { + # parse the parameters when run this script locally + $requestType = $ARGV[0]; + $pathInfo= $ARGV[1]; + + unless ($pathInfo) { dbgusage(); exit 1; } + + if ($ARGV[2] =~ /(.*):(.*)/) { + $ENV{userName} = $1; + $ENV{password} = $2; + } else { + dbgusage(); + exit 0; + } + $dbgdata = $ARGV[3] if defined ($ARGV[3]); +} elsif (defined ($ARGV[0])) { + dbgusage(); + exit 1; +} my $JSON; # global ptr to the json object. Its set by loadJSON() -if (isPut() || isPost()) { loadJSON(); } # need to do this early, so we can fetch the params +# Since the json is the only supported format, load it at beginning +# need to do this early, so we can fetch the PUT/POST params +loadJSON(); -# the input parameters from both the url and put/post data will combined and then +# the input parameters from both the url and put/post data will be combined and then # separated into the general params (not specific to the api call) and params specific to the call # Note: some of the values of the params in the hash can be arrays +# $generalparams - the general parameters like 'debug=1', 'pretty=1' +# $paramhash - all parameters that come from the url or put/post data except the ones that are put in $generalparams my ($generalparams, $paramhash) = fetchParameters(); -# sometimes we need to know the params that are not specific to the resource or action my $DEBUGGING = $generalparams->{debug}; # turn on or off the debugging output by setting debug=1 (or 2) in the url string if ($DEBUGGING) { - addPageContent($q->p("DEBUG: generalparams:". Dumper($generalparams))); - addPageContent($q->p("DEBUG: paramhash:". Dumper($paramhash))); - addPageContent($q->p("DEBUG: q->request_method: $requestType\n")); - addPageContent($q->p("DEBUG: q->user_agent: $userAgent\n")); - addPageContent($q->p("DEBUG: pathInfo: $pathInfo\n")); - #addPageContent($q->p("DEBUG: path " . Dumper(@path) . "\n")); - #foreach (keys(%ENV)) { addPageContent($q->p("DEBUG: ENV{$_}: $ENV{$_}\n")); } - addPageContent($q->p("DEBUG: resource: $resource\n")); - #addPageContent($q->p("DEBUG: userName=".$paramhash->{userName}.", password=".$paramhash->{password}."\n")); - #addPageContent($q->p("DEBUG: http() values:\n" . http() . "\n")); - #if ($pdata) { addPageContent($q->p("DEBUG: pdata: $pdata\n")); } - addPageContent("\n"); - if ($DEBUGGING == 3) { - sendResponseMsg($STATUS_OK); # this will also exit - } + displaydebugmsg(); } +# The filter flag is used to group the nodes which have the same output +my $XCOLL = $generalparams->{xcoll}; + # Process the format requested -my $format = $generalparams->{format}; -if (!$format) { $format = 'json'; } # this is the default format +$format = $generalparams->{format} if (defined ($generalparams->{format})); + +# Remove the last '/' in the pathInfo +$pathInfo =~ s/\/$//; + +# Get the payload format from the end of URI +#if ($pathInfo =~ /\.json$/) { +# $format = "json"; +# $pathInfo =~ s/\.json$//; +#} elsif ($pathInfo =~ /\.json.pretty$/) { +# $format = "json"; +# $pretty = 1; +# $pathInfo =~ s/\.json.pretty$//; +#} elsif ($pathInfo =~ /\.xml$/) { +# $format = "xml"; +# $pathInfo =~ s/\.xml$//; +#} elsif ($pathInfo =~ /\.html$/) { +# $format = "html"; +# $pathInfo =~ s/\.html$//; +#} + +#if (!exists $formatters{$format}) { +# error("The format '$format' is not supported",$STATUS_BAD_REQUEST); +#} + if ($format eq 'json') { - loadJSON(); # in case it was not loaded before + # make the output to be readable if 'pretty=1' is specified if ($generalparams->{pretty}) { $JSON->indent(1); } } -# supported formats -my %formatters = ( - 'html' => \&wrapHtml, - 'json' => \&wrapJson, - 'xml' => \&wrapXml - ); - - -if (!exists $formatters{$format}) { - error("The format '$format' is not supported",$STATUS_BAD_REQUEST); -} - -# require XML dynamically and let them know if it is not installed # we need XML all the time to send request to xcat, even if thats not the return format requested by the user -my $xmlinstalled = eval { require XML::Simple; }; -unless ($xmlinstalled) { - error('The XML::Simple perl module is missing. Install perl-XML-Simple before using the xCAT REST web services API with this format."}',$STATUS_SERVICE_UNAVAILABLE); -} -$XML::Simple::PREFERRED_PARSER = 'XML::Parser'; -#debugandexit('here'); +loadXML(); -#resource handlers -my %resources = ( - groups => \&groupsHandler, - images => \&imagesHandler, - logs => \&logsHandler, - monitors => \&monitorsHandler, - networks => \&networksHandler, - nodes => \&nodesHandler, - notifications => \¬ificationsHandler, - policies => \&policiesHandler, - site => \&siteHandler, - tables => \&tablesHandler, - accounts => \&accountsHandler, - objects => \&objectsHandler, - vms => \&vmsHandler, - debug => \&debugHandler, - hypervisor => \&hypervisorHandler, - version => \&versionHandler); +# The first layer of resource URI. It should be 'nodes' for URI '/nodes/node1' +my $uriLayer1; -#if no resource was specified -if ($pathInfo =~ /^\/$/ || $pathInfo =~ /^$/) { - addPageContent($q->p("This is the root page for the xCAT Rest Web Service. Available resources are:")); - foreach (sort keys %resources) { - addPageContent($q->p($_)); +# Get all the layers in the URI +my @layers = split('\/', $pathInfo); +shift (@layers); + +if ($#layers < 0) { + # If no resource was specified, list all the resource groups which have been defined in the %URIdef + my $json; + foreach (sort keys %URIdef) { + push @{$json}, $_; + } + if ($json) { + addPageContent($JSON->encode($json)); } sendResponseMsg($STATUS_OK); # this will also exit +} else { + $uriLayer1 = $layers[0]; } -#my @imageFields = ( -# 'imagename', 'profile', 'imagetype', 'provmethod', 'osname', 'osvers', -# 'osdistro', 'osarch', 'synclists', 'comments', 'disable'); +# set the user and password to access xcatd +$request->{becomeuser}->[0]->{username}->[0] = $ENV{userName} if (defined($ENV{userName})); +$request->{becomeuser}->[0]->{username}->[0] = $generalparams->{userName} if (defined($generalparams->{userName})); +$request->{becomeuser}->[0]->{password}->[0] = $ENV{password} if (defined($ENV{password})); +$request->{becomeuser}->[0]->{password}->[0] = $generalparams->{password} if (defined($generalparams->{password})); -my $formatType; # global var for tablesHandler to pass the splitCommas option to wrapHtml +# use the token if it is specified with X_AUTH_TOKEN head +$request->{tokens}->[0]->{tokenid}->[0] = $ENV{'HTTP_X_AUTH_TOKEN'} if (defined($ENV{'HTTP_X_AUTH_TOKEN'})); -#general tests for valid requests and responses with HTTP codes here -if (!exists($resources{$resource})) { - error("Resource '$resource' does not exist",$STATUS_NOT_FOUND); # this will also exit -} - -# Main function - process user request -handleRequest(); -# end of main - -# The flow of functions is: -# handleRequest() - do the whole api call -# *Handler() - the specific handler routine for this resource -# genRequest() - convert xcat request to xml to prepare it for sending to xcatd -# sendRequest() - send the request to xcatd and read the xml response and convert it to a perl structure -# wrapData() - convert the output to the format requested by the user -# wrap*() - the specific formatter the user requested -# sendResponseMsg() - form/send the output header, and then exit - -# Call one of the handler routines to process the api call, and then return the output -sub handleRequest { - if ($generalparams->{userName} && $generalparams->{password}) { - $request->{becomeuser}->[0]->{username}->[0] = $generalparams->{userName}; - $request->{becomeuser}->[0]->{password}->[0] = $generalparams->{password}; +# find and invoke the correct handler and output handler functions +my $outputdata; +my $handled; +if (defined ($URIdef{$uriLayer1})) { + # Make sure the resource has been defined + foreach my $res (keys %{$URIdef{$uriLayer1}}) { + my $matcher = $URIdef{$uriLayer1}->{$res}->{matcher}; + if ($pathInfo =~ m|$matcher|) { + # matched to a resource + unless (defined ($URIdef{$uriLayer1}->{$res}->{$requestType})) { + error("request method '$requestType' is not supported on resource '$pathInfo'", $STATUS_NOT_ALLOWED); + } + if (defined ($URIdef{$uriLayer1}->{$res}->{$requestType}->{fhandler})) { + my $params; + + $params->{'cmd'} = $URIdef{$uriLayer1}->{$res}->{$requestType}->{cmd} if (defined ($URIdef{$uriLayer1}->{$res}->{$requestType}->{cmd})); + $params->{'outputhdler'} = $URIdef{$uriLayer1}->{$res}->{$requestType}->{outhdler} if (defined ($URIdef{$uriLayer1}->{$res}->{$requestType}->{outhdler})); + $params->{'layers'} = \@layers; + $params->{'resourcegroup'} = $uriLayer1; + $params->{'resourcename'} = $res; + # Call the handler subroutine which specified in 'fhandler' to send request to xcatd and get the response + $outputdata = $URIdef{$uriLayer1}->{$res}->{$requestType}->{fhandler}->($params); + # Filter the output data from the response + $outputdata = filterData ($outputdata); + # Restructure the output data with the subroutine which is specified in 'outhdler' + if (defined ($URIdef{$uriLayer1}->{$res}->{$requestType}->{outhdler})) { + $outputdata = $URIdef{$uriLayer1}->{$res}->{$requestType}->{outhdler}->($outputdata, $params); + } else { + # Call the appropriate formatting function stored in the formatters hash as default output handler + if (exists $formatters{$format}) { + $formatters{$format}->($outputdata); + } + } + + $handled = 1; + last; + } + } } - # this calls one of the handler routines that are stored in the resources hash - my $data = $resources{$resource}->(); - wrapData($data); +} else { + # not matches to any resource group. Check the 'resource group' to improve the performance + error("Unspported resource.",$STATUS_NOT_FOUND); } -# handle all the api calls for listing nodes, modifying nodes, querying nodes, running cmds on nodes, etc. -sub nodesHandler { - my $responses; +# the URI cannot match to any resources which are defined in %URIdef +unless ($handled) { + error("Unspported resource.",$STATUS_NOT_FOUND); +} + + +# all output has been added into the global varibale pageContent, call the response funcion to generate HTTP reply and exit + +if (isPost()) { + sendResponseMsg($STATUS_CREATED); +} +else { + sendResponseMsg($STATUS_OK); +} + +#### End of the Main Program + + + + + +#=========================================================== +# Subrutines +sub isGET { return uc($requestType) eq "GET"; } +sub isPost { return uc($requestType) eq "POST"; } +sub isPut { return uc($requestType) eq "PUT"; } +sub isPost { return uc($requestType) eq "POST"; } +sub isPatch { return uc($requestType) eq "PATCH"; } +sub isDelete { return uc($requestType) eq "DELETE"; } + + +#handle the output for def command and rscan +#handle the input like +# ===raw xml input +# $d->{info}->[msg list] - each msg could be mulitple msg which split with '\n' +# $d->{data}->[msg list] +# +# ===msg format +# Object name: +# attr=value +#OR +# : +# attr=value +# --- +#TO +# --- +# { : { +# attr : value +# ... +# } ... } +sub defout { + my $data = shift; + + my $json; + foreach my $d (@$data) { + my $nodename; + my $lines; + my @alldata; + if (defined ($d->{info})) { + foreach (@{$d->{info}}) { + push @alldata, split ('\n', $_); + } + $lines = \@alldata; + } elsif (defined ($d->{data})) { + foreach (@{$d->{data}}) { + push @alldata, split ('\n', $_); + } + $lines = \@alldata; + } + foreach my $l (@$lines) { + if ($l =~ /^Object name: / || $l =~ /^\S+:$/) { # start new node + if ($l =~ /^Object name:\s+(\S+)/) { # handle the output of lsdef -t + $nodename = $1; + } + if ($l =~ /^(\S+):$/) { # handle the output for stanza format '-z' + $nodename = $1; + } + } + else { # just an attribute of the current node + if (! $nodename) { error('improperly formatted lsdef output from xcatd', $STATUS_TEAPOT); } + my ($attr, $val) = $l =~ /^\s*(\S+)=(.*)$/; + if (!defined($attr)) { error('improperly formatted lsdef output from xcatd', $STATUS_TEAPOT); } + $json->{$nodename}->{$attr} = $val; + } + } + } + if ($json) { + addPageContent($JSON->encode($json), 1); + } +} + +#handle the output for lsdef -t command +#handle the input like +# ===raw xml input +# $d->{info}->[msg list] - each msg could be mulitple msg which split with '\n' +# +# ===msg format +# node1 (node) +# node2 (node) +# node3 (node) +# --- +#TO +# --- +# node1 +# node2 +# node3 +sub defout_remove_appended_type { + my $data = shift; + + my $json; + foreach my $d (@$data) { + my $jsonnode; + my $lines = $d->{info}; + foreach my $l (@$lines) { + if ($l =~ /^(\S*)\s+\(.*\)$/) { # start new node + push @{$json}, $1; + } + } + } + if ($json) { + addPageContent($JSON->encode($json), 1); + } +} + +# hanlde the output which has the node irrelevant message (e.g. the output for updatenode command) +# handle the input like +# ===raw xml input +# $d->{info}->[msg list] - each msg could be mulitple msg which split with '\n' +# $d->{data}->[msg list] +# $d->{data}->{contents}->[msg list] +# +# ===msg format +# "There were no syncfiles defined to process. File synchronization has completed.", +# "Performing software maintenance operations. This could take a while, if there are packages to install.", +# "node2: Tue Apr 2 15:55:57 CST 2013 Running postscript: ospkgs", +# --- +#TO +# --- +# [ +# "There were no syncfiles defined to process. File synchronization has completed.", +# "Performing software maintenance operations. This could take a while, if there are packages to install.", +# "node2: Tue Apr 2 15:55:57 CST 2013 Running postscript: ospkgs", +# ] +# +# An exception is to handle the output of 'xdsh'(nodeshell). Since each msg has a : head, split the head out and group +# the msg with the name in the head. + +sub infoout { + my $data = shift; + my $param =shift; + + my $json; + foreach my $d (@$data) { + if (defined ($d->{info})) { + foreach (@{$d->{info}}) { + push @{$json}, split ('\n', $_); + } + } + if (defined ($d->{data})) { + if (ref($d->{data}->[0]) ne "HASH") { + foreach (@{$d->{data}}) { + push @{$json}, split ('\n', $_); + } + } else { + if (defined($d->{data}->[0]->{contents})) { + push @{$json}, @{$d->{data}->[0]->{contents}}; + } + } + } + if (defined ($d->{error})) { + push @{$json}, @{$d->{error}}; + } + } + + # for nodeshell (xdsh), group msg with node name + if ($param->{'resourcename'} =~ /(nodeshell|postscript|software_maintenance)/) { + my $jsonnode; + foreach (@{$json}) { + if (/^(\S+):(.*)$/) { + push @{$jsonnode->{$1}}, $2 if ($2 !~ /^\s*$/); + } + } + addPageContent($JSON->encode($jsonnode), 1) if ($jsonnode); + return; + } + if ($json) { + addPageContent($JSON->encode($json), 1); + } +} + +# hanlde the output which is node relevant (rpower, rinv, rvitals ...) +# the output must be grouped with 'node' as key +# handle the input like +# ===raw xml input +# $d->{node}->{name}->[name] # this is must have, otherwise ignore the msg +# $d->{node}->{data}->[msg] +#OR +# $d->{node}->{name}->[name] # this is must have, otherwise ignore the msg +# $d->{node}->{data}->{contents}->[msg] +#OR +# $d->{node}->{name}->[name] # this is must have, otherwise ignore the msg +# $d->{node}->{data}->{contents}->[msg] +# $d->{node}->{data}->{desc}->[msg] +# +# Note: if does not have '$d->{node}->{data}->{desc}', use the resource name as the name of attribute. +# e.g. Get /node/node1/power, the record is '"power":"off"' +# +# ===msg format +# +# +# 1.41 (VVE128GUS 2013/07/22) +# UEFI Version +# +# node1 +# +# --- +#TO +# --- +# { +# "node1":{ +# "UEFI Version":"1.41 (VVE128GUS 2013/07/22)", +# } +# } +sub actionout { + my $data = shift; + my $param =shift; + + my $jsonnode; + foreach my $d (@$data) { + unless (defined ($d->{node}->[0]->{name})) { + next; + } + if (defined ($d->{node}->[0]->{data}) && (ref($d->{node}->[0]->{data}->[0]) ne "HASH" || ! defined($d->{node}->[0]->{data}->[0]->{contents}))) { + # no $d->{node}->{data}->{contents} or $d->{node}->[0]->{data} is not hash + $jsonnode->{$d->{node}->[0]->{name}->[0]}->{$param->{'resourcename'}} = $d->{node}->[0]->{data}->[0]; + } elsif (defined ($d->{node}->[0]->{data}->[0]->{contents})) { + if (defined($d->{node}->[0]->{data}->[0]->{desc})) { + # has $d->{node}->{data}->{desc} + $jsonnode->{$d->{node}->[0]->{name}->[0]}->{$d->{node}->[0]->{data}->[0]->{desc}->[0]} = $d->{node}->[0]->{data}->[0]->{contents}->[0]; + } else { + # use resourcename as the record name + if ($param->{'resourcename'} eq "eventlog") { + push @{$jsonnode->{$d->{node}->[0]->{name}->[0]}->{$param->{'resourcename'}}}, $d->{node}->[0]->{data}->[0]->{contents}->[0]; + } else { + $jsonnode->{$d->{node}->[0]->{name}->[0]}->{$param->{'resourcename'}} = $d->{node}->[0]->{data}->[0]->{contents}->[0]; + } + } + } + } + + addPageContent($JSON->encode($jsonnode), 1) if ($jsonnode); +} + +# hanlde the output which has the token id +# handle the input like +# ===raw xml input +# $d->{data}->{token}->{id} +# $d->{data}->{token}->{expire} +sub tokenout { + my $data = shift; + + my $json; + foreach my $d (@$data) { + if (defined ($d->{data}) && defined ($d->{data}->[0]->{token})) { + $json->{token}->{id} = $d->{data}->[0]->{token}->[0]->{id}->[0]; + $json->{token}->{expire} = $d->{data}->[0]->{token}->[0]->{expire}->[0]; + } + } + + if ($json) { + addPageContent($JSON->encode($json)); + } +} + +# This is the general callback subroutine for PUT/POST/DELETE methods +# when this subroutine is called, that means the operation has been done successfully +# The correct output is 'null' +sub noout { + return; +### for debugging + my $data = shift; + + addPageContent(qq(\n\n\n=======================================================\nDebug: Following message is just for debugging. It will be removed in the GAed version.\n)); + + my $json; + if ($data) { + addPageContent($JSON->encode($data)); + } + + addPageContent(qq(["Debug: the operation has been done successfully"])); +### finish the debugging +} + +# The operation callback subroutine for def related resource (lsdef, chdef ...) +# assembe the xcat request, send it to xcatd and get response +sub defhdl { + my $params = shift; + my @args; - my $noderange; - my @envs; + my @urilayers = @{$params->{'layers'}}; - if (defined $path[1]) { - $noderange = $path[1]; + # set the command name + $request->{command} = $params->{'cmd'}; + + # push the -t args for *def command + my $resrctype = $params->{'resourcegroup'}; + $resrctype =~ s/s$//; # remove the last 's' as the type of object + push @args, ('-t', $resrctype); + + # push the object name - node/noderange + if (defined ($urilayers[1])) { + push @args, ('-o', $urilayers[1]); } - if (isGet()) { - my $subResource; - if (defined $path[2]) { - $subResource = $path[2]; - unless (defined($noderange)) { - error("Invalid nodes and/or groups in noderange",$STATUS_BAD_REQUEST); - } - $request->{noderange} = $noderange; + # For the put/post which specifies attributes like mgt=ipmi groups=all + foreach my $k (keys(%$paramhash)) { + push @args, "$k=$paramhash->{$k}" if ($k); + } + + if ($params->{'resourcename'} eq "allnode") { + push @args, '-s'; + } elsif ($params->{'resourcename'} =~ /(nodeattr|osimage_attr|group_attr|policy_attr|network_attr)/) { + # if /nodes/node1/attrs/attr1,att2 is specified, for get request, + # use 'lsdef -i' to specify the attribute list + my $attrs = $urilayers[3]; + $attrs =~ s/;/,/g; - #use the corresponding command by the subresource name - if ($subResource eq "power") { - $request->{command} = 'rpower'; - push @args, 'stat'; - } - elsif ($subResource eq "energy") { - $request->{command} = 'renergy'; - - if (ref($paramhash->{field}) eq 'ARRAY') { push @args, @{$paramhash->{field}}; } - elsif (defined($paramhash->{field})) { push @args, $paramhash->{field}; } - else { error('field must be specified for node energy action', $STATUS_BAD_REQUEST); } - } - elsif ($subResource eq "status") { - $request->{command} = 'nodestat'; - } - elsif ($subResource eq "inventory") { - $request->{command} = 'rinv'; - if (ref($paramhash->{field}) eq 'ARRAY') { push @args, @{$paramhash->{field}}; } - elsif (defined($paramhash->{field})) { push @args, $paramhash->{field}; } - else { - push @args, 'all'; - } - } - elsif ($subResource eq "vitals") { - $request->{command} = 'rvitals'; - if (ref($paramhash->{field}) eq 'ARRAY') { push @args, @{$paramhash->{field}}; } - elsif (defined($paramhash->{field})) { push @args, $paramhash->{field}; } - else { - push @args, 'all'; - } - } - elsif ($subResource eq "scan") { - $request->{command} = 'rscan'; - if (ref($paramhash->{field}) eq 'ARRAY') { push @args, @{$paramhash->{field}}; } - elsif (defined($paramhash->{field})) { push @args, $paramhash->{field}; } - } - else { - error("Unspported operation on nodes resource.",$STATUS_BAD_REQUEST); - } - } - else { # no path[2] was specified - - # maybe field parameters were also specified - my $value = $paramhash->{field}; - if (defined($value)) { - $request->{command} = 'lsdef'; - # add the nodegroup into args - if (defined($noderange)) { push @args, $noderange; } - if (!ref($value) && $value eq 'ALL') { push @args, '-l'; } - else { - push @args, "-i"; - if (ref($value) eq 'ARRAY') { push @args, join(',', @$value); } - else { push @args, $value; } - } - } - else { - # not asking for attribute values, use nodels, its faster - $request->{command} = 'nodels'; - if (defined($noderange)) { $request->{noderange} = $noderange; } - } - } - } - elsif (isPut()) { # this could be change node attributes, power state, etc. - my $subResource; - - unless (defined($noderange)) { - error("Invalid nodes or groups in noderange",$STATUS_BAD_REQUEST); - } - $request->{noderange} = $noderange; - - if (defined $path[2]) { - $subResource = $path[2]; # this is the action like power, energy - - # For all of these put calls, move all operands to the argument list. - foreach my $k (keys %$paramhash) { - my $param = $paramhash->{$k}; - if (ref($param) eq 'ARRAY') { push @args, @$param; } - else { push @args, $param; } - } - if ($subResource eq "power") { - $request->{command} = "rpower"; - unless (scalar(keys(%$paramhash))) { - error("No power operands were supplied.",$STATUS_BAD_REQUEST); - } - } - elsif ($subResource eq "energy") { - $request->{command} = "renergy"; - } - elsif ($subResource eq "bootstat" or $subResource eq "bootstate") { - $request->{command} = "nodeset"; - } - elsif ($subResource eq "bootseq") { - $request->{command} = "rbootseq"; - } - elsif ($subResource eq "setboot") { - $request->{command} = "rsetboot"; - } - elsif ($subResource eq "migrate") { - $request->{command} = "rmigrate"; - } - else { error("unsupported node resource subResource $subResource.", $STATUS_BAD_REQUEST); } - } - else { # no path[2] set, setting node attributes in the db - $request->{command} = "chdef"; - push @args, "-t", "node"; - push @args, "-o", $request->{noderange}; - - # input is a json object with key/value pairs - while (my ($name, $val) = each (%$paramhash)) { - push @args, $name . "=" . $val; - } - } - } - elsif (isPost()) { # this can be dsh, dcp, or creating a node def - my $subResource; - - unless (defined($noderange)) { - error("Invalid nodes or groups in noderange",$STATUS_BAD_REQUEST); - } - - if (defined $path[2]) { - $subResource = $path[2]; # this is the action like dsh or dcp - $request->{noderange} = $noderange; - if ($subResource eq "dsh") { - $request->{command} = "xdsh"; - # flags (options) for xdsh. Format of this array: - my @flags = ( - [qw(devicetype --devicetype 1)], - [qw(execute -e 0)], - [qw(environment -E 1)], - [qw(fanout -f 1)], - [qw(nolocale -L 0)], - [qw(userid -l 1)], - [qw(monitor -m 0)], - [qw(options -o 1)], - [qw(showconfig -q 0)], - [qw(silent -Q 0)], - [qw(remoteshell -r 1)], - [qw(syntax -S 1)], - [qw(timeout -t 1)], - [qw(envlist -X 1)], - [qw(sshsetup -K 1)], - [qw(rootimg -i 1)], - ); - pushFlags(\@args, \@flags); - if (defined($paramhash->{'command'})) { - push @args, $paramhash->{'command'}; - } - if (defined($paramhash->{'remotepasswd'})) { - push @envs, 'DSH_REMOTE_PASSWORD=' . $paramhash->{'remotepasswd'}; - push @envs, 'DSH_FROM_USERID=root'; - push @envs, 'DSH_TO_USERID=root'; # i think this is overridden with the 'userid' param - } - } - elsif ($subResource eq "dcp") { - $request->{command} = "xdcp"; - # flags (options) for xdcp. Format of this array: - my @flags = ( - [qw(fanout -f 1)], - [qw(options -o 1)], - [qw(showconfig -q 0)], - [qw(remotecopy -r 1)], - [qw(timeout -t 1)], - [qw(rootimg -i 1)], - [qw(rsyncfile -F 1)], - [qw(preserve -p 0)], - [qw(pull -P 0)], - [qw(recursive -R 0)], - ); - pushFlags(\@args, \@flags); - if (defined($paramhash->{'source'})) { - push @args, $paramhash->{'source'}; - } - if (defined($paramhash->{'target'})) { - push @args, $paramhash->{'target'}; - } - } - else { error("unsupported node resource subResource $subResource.", $STATUS_BAD_REQUEST); } - } - else { # create a node def - $request->{command} = 'mkdef'; - push @args, "-t", "node"; - - unless (defined($noderange)) { - error("No nodename was supplied.",$STATUS_BAD_REQUEST); - } - - push @args, "-o", $noderange; - - if (scalar(keys(%$paramhash))) { - while (my ($name, $val) = each (%$paramhash)) { - push @args, $name . "=" . $val; - } - } - else { error('no input parameters given.', $STATUS_BAD_REQUEST); } - } - } - elsif (isDelete()) { # deleting a node def - $request->{command} = 'rmdef'; - push @args, "-t", "node"; - unless (defined($noderange)) { - error("No nodename was supplied.",$STATUS_BAD_REQUEST); - } - push @args, "-o", $noderange; - } - else { - unsupportedRequestType(); + if (isGET()) { + push @args, ('-i', $attrs); + } } - push @{$request->{arg}}, @args; - if (@envs) { - push @{$request->{env}}, @envs; - } - #debug("request: " . Dumper($request)); + push @{$request->{arg}}, @args; my $req = genRequest(); - $responses = sendRequest($req); + my $responses = sendRequest($req); return $responses; } -#get is done -#post and delete are done but not tested -#groupfiles4dsh is done but not tested -sub groupsHandler { - my $responses; +# The operation callback subroutine for any node related resource (power, energy ...) +# assembe the xcat request, send it to xcatd and get response +sub actionhdl { + my $params = shift; + my @args; - my $groupName; + my @urilayers = @{$params->{'layers'}}; - my @groupFields = ('groupname', 'grouptype', 'members', 'wherevals', 'comments', 'disable'); + # set the command name + $request->{command} = $params->{'cmd'}; - #is the group name in the URI? - if (defined $path[1]) { - $groupName = $path[1]; + # push the object name - node/noderange + if (defined ($urilayers[1])) { + $request->{noderange} = $urilayers[1]; } - #in the query string? - else { - $groupName = $q->param('groupName'); - } - - if (isGet()) { - if (defined $groupName) { - $request->{command} = 'tabget'; - push @args, "groupname=$groupName"; - if (defined $q->param('field')) { - foreach ($q->param('field')) { - push @args, "nodegroup.$_"; - } - } - else { - foreach (@groupFields) { - push @args, "nodegroup.$_"; - } - } + if ($params->{'resourcename'} eq "power") { + if (isGET()) { + push @args, 'stat'; + } elsif ($paramhash->{'action'}) { + #my @v = keys(%$paramhash); + push @args, $paramhash->{'action'}; + } else { + error("Missed Action.",$STATUS_NOT_FOUND); } - else { - $request->{command} = 'tabdump'; - push @args, 'nodegroup'; + } elsif ($params->{'resourcename'} =~ /(energy|energyattr)/) { + if (isGET()) { + if ($params->{'resourcename'} eq "energy") { + push @args, 'all'; + } elsif ($params->{'resourcename'} eq "energyattr") { + my @attrs = split(',', $urilayers[3]); + push @args, @attrs; + } + } elsif ($paramhash) { + my @params = keys(%$paramhash); + push @args, "$params[0]=$paramhash->{$params[0]}"; + } else { + error("Missed Action.",$STATUS_NOT_FOUND); } - } - - #does it make sense to even have this? - elsif (isPost()) { - my $nodeRange = $q->param('nodeRange'); - if ((defined $groupName) && (defined $nodeRange)) { - $request->{command} = 'mkdef'; - push @args, '-t'; - push @args, 'group'; - push @args, '-o'; - push @args, $groupName; - push @args, "members=$nodeRange"; + } elsif ($params->{'resourcename'}eq "bootstate") { + if (isGET()) { + push @args, 'stat'; + } elsif ($paramhash->{'action'}) { + push @args, $paramhash->{'action'}; + } elsif ($paramhash) { + my @params = keys(%$paramhash); + if ($params[0] eq "state") { + # hanlde the {state:offline} + push @args, $paramhash->{$params[0]}; + } else { + # handle the {osimage:imagename} + push @args, "$params[0]=$paramhash->{$params[0]}"; + } + } else { + error("Missed Action.",$STATUS_NOT_FOUND); } - else { - addPageContent("A node range and group name must be specified for creating a group"); - sendResponseMsg($STATUS_BAD_REQUEST); + } elsif ($params->{'resourcename'} eq "nextboot") { + if (isGET()) { + push @args, 'stat'; + } elsif ($paramhash->{'order'}) { + push @args, $paramhash->{'order'}; + } else { + error("Missed Action.",$STATUS_NOT_FOUND); } - } - elsif (isPut()) { - - #handle groupfiles4dsh -p /tmp/nodegroupfiles - if ($q->param('command') eq "4dsh") { - if ($q->param('path')) { - $request->{command} = 'groupfiles4dsh'; - push @args, "p=$q->param('path')"; - } - else { - addPageContent("The path must be specified for creating directories for dsh"); - sendResponseMsg($STATUS_BAD_REQUEST); - } + } elsif ($params->{'resourcename'} =~ /(vitals|vitalsattr|inventory|inventoryattr)/) { + if (defined($urilayers[3])) { + my @attrs = split(';', $urilayers[3]); + push @args, @attrs; } - else { - if (defined $groupName && defined $q->param('fields')) { - $request->{command} = 'nodegrpch'; - push @args, $groupName; - push @args, $q->param('field'); - } - else { - addPageContent("The group and fields must be specified to update groups"); - sendResponseMsg($STATUS_BAD_REQUEST); - } + } elsif ($params->{'resourcename'} eq "serviceprocessor") { + if (isGET()) { + push @args, $urilayers[3]; + } elsif ($paramhash->{'value'}) { + push @args, $urilayers[3]."=".$paramhash->{'value'}; } - } - elsif (isDelete()) { - if (defined $groupName) { - $request->{command} = 'rmdef'; - push @args, '-d'; - push @args, 'group'; - push @args, '-o'; - push @args, $groupName; + } elsif ($params->{'resourcename'} eq "eventlog") { + if (isGET()) { + push @args, 'all'; + } elsif (isDelete()) { + push @args, 'clear'; } - else { - addPageContent("The group must be specified to delete a group"); - sendResponseMsg($STATUS_BAD_REQUEST); - } - } - else { - unsupportedRequestType(); - } - - push @{$request->{arg}}, @args; - my $req = genRequest(); - $responses = sendRequest($req); - - return $responses; -} - -#get is done, nothing else -sub imagesHandler { - my $responses; - my @args; - my $image; - my $subResource; - - if (defined($path[1])) { - $image = $path[1]; - } - - if (isGet()) { - $request->{command} = 'lsdef'; - push @args, '-t', 'osimage'; - if (defined $image) { - push @args, '-o', $image; - } - if (defined($q->param('field'))) { - push @args, '-i'; - push @args, join(',', $q->param('field')); - } - if (defined($q->param('criteria'))) { - foreach ($q->param('criteria')) { - push @args, '-w', "$_"; - } - } - } - elsif (isPost()) { - my $operationname = $image; - my $entries; - my %entryhash; - - # check input - unless (scalar(keys(%$paramhash))) { - error("no parameters specified", $STATUS_BAD_REQUEST); - } - - #for image capture - if ($operationname eq 'capture') { - $request->{command} = 'imgcapture'; - if (defined($paramhash->{'nodename'})) { - $request->{noderange} = $paramhash->{'nodename'}; - } - else { - addPageContent('No node range.'); - sendResponseMsg($STATUS_BAD_REQUEST); - } - - if (defined($paramhash->{'profile'})) { - push @args, '-p'; - push @args, $paramhash->{'profile'}; - } - if (defined($paramhash->{'osimage'})) { - push @args, '-o'; - push @args, $paramhash->{'osimage'}; - } - if (defined($paramhash->{'bootinterface'})) { - push @args, '-i'; - push @args, $paramhash->{'bootinterface'}; - } - if (defined($paramhash->{'netdriver'})) { - push @args, '-n'; - push @args, $paramhash->{'netdriver'}; - } - if (defined($paramhash->{'device'})) { - push @args, '-d'; - push @args, $paramhash->{'device'}; - } - } - elsif ($operationname eq 'export') { - $request->{command} = 'imgexport'; - if (defined($paramhash->{'osimage'})) { - push @args, $paramhash->{'osimage'}; - } - else { - addPageContent('No image specified'); - sendResponseMsg($STATUS_BAD_REQUEST); - } - - if (defined($paramhash->{'destination'})) { - push @args, $paramhash->{'destination'}; - } - if (defined($paramhash->{'postscripts'})) { - push @args, '-p'; - push @args, $paramhash->{'postscripts'}; - } - if (defined($paramhash->{'extra'})) { - push @args, '-e'; - push @args, $paramhash->{'extra'}; - } - if (defined($paramhash->{'remotehost'})) { - push @args, '-R'; - push @args, $paramhash->{'remotehost'}; - } - if (defined($paramhash->{'verbose'})) { - push @args, '-v'; - } - } - elsif ($operationname eq 'import') { - $request->{command} = 'imgimport'; - if (defined($paramhash->{'osimage'})) { - push @args, $paramhash->{'osimage'}; - } - else { - addPageContent('No image specified'); - sendResponseMsg($STATUS_BAD_REQUEST); - } - - if (defined($paramhash->{'profile'})) { - push @args, '-f'; - push @args, $paramhash->{'profile'}; - } - if (defined($paramhash->{'remotehost'})) { - push @args, '-R'; - push @args, $paramhash->{'remotehost'}; - } - if (defined($paramhash->{'postscripts'})) { - push @args, '-p'; - push @args, $paramhash->{'postscripts'}; - } - - if (defined($paramhash->{'verbose'})) { - push @args, '-v'; - } - } - } - elsif (isPut()) { - - #check the operation type - unless (defined $path[2]) { - addPageContent("The subResource $subResource does not exist"); - sendResponseMsg($STATUS_BAD_REQUEST); - } - - $subResource = $path[2]; - - #check the image name - unless (defined $image) { - addPageContent("The image name is required to clean an os image"); - sendResponseMsg($STATUS_BAD_REQUEST); - } - - if ($subResource eq 'check') { - $request->{command} = 'chkosimage'; - if (defined($q->param('PUTDATA'))) { - push @args, '-c'; - } - push @args, $image; - } - else { - addPageContent("The subResource $subResource does not exist"); - sendResponseMsg($STATUS_BAD_REQUEST); - } - } - elsif (isDelete()) { - if (defined $image) { - $request->{command} = 'rmimage'; - if (defined $q->param('verbose')) { - push @args, '-v'; - } - push @args, $image; - } - elsif (defined $q->param('os') && defined $q->param('arch') && defined $q->param('profile')) { - push @args, '-o'; - push @args, $q->param('os'); - push @args, '-a'; - push @args, $q->param('arch'); - push @args, '-p'; - push @args, $q->param('profile'); - } - else { - addPageContent( - "Either the image name or the os, architecture and profile must be specified to remove an image"); - sendResponseMsg($STATUS_BAD_REQUEST); - } - } - else { - unsupportedRequestType(); - } - - push @{$request->{arg}}, @args; - my $req = genRequest(); - $responses = sendRequest($req); - - return $responses; -} - -#complete -sub logsHandler { - my $responses; - my @args; - my $logType; - - if (defined $path[1]) { - $logType = $path[1]; - } - - #in the query string? - else { - $logType = $q->param('logType'); - } - my $nodeRange = $q->param('nodeRange'); - - #no real output unless the log type is defined - if (!defined $logType) { - addPageContent("Current logs available are auditlog and eventlog"); - sendResponseMsg($STATUS_BAD_REQUEST); - exit(0); - } - - if (isGet()) { - if ($logType eq "reventLog") { - if (defined $nodeRange) { - $request->{command} = 'reventlog'; - push @args, $nodeRange; - if (defined $q->param('count')) { - push @args, $q->param('count'); - } - } - else { - addPageContent("nodeRange must be specified to GET remote event logs"); - sendResponseMsg($STATUS_BAD_REQUEST); - } - } - else { - $request->{command} = 'tabdump'; - push @args, $logType; - } - } - - #this clears the log - elsif (isPut()) { - if ($logType eq "reventlog") { - if (defined $nodeRange) { - $request->{command} = 'reventlog'; - push @args, $nodeRange; - push @args, 'clear'; - } - else { - addPageContent("nodeRange must be specified to clean remote event logs"); - sendResponseMsg($STATUS_BAD_REQUEST); - } - } - else { - - #should it return the removed entries? - if (defined $q->param('showRemoved')) { - push @args, '-V'; - } - if (defined $q->param('count') || defined $q->param('percent') || defined $q->param('lastRecord')) { - - #remove some of the entries - $request->{command} = 'tabprune'; - - #remove a certain number of records - if (defined $q->param('count')) { - push @args, ('-n', $q->param('count')); - } - - #remove a percentage of the records - if (defined $q->param('percent')) { - push @args, ('-p', $q->param('percent')); - } - - #remove all records before this record - if (defined $q->param('lastRecord')) { - push @args, ('-i', $q->param('lastRecord')); - } - } - else { - $request->{command} = 'tabprune'; - - #-a removes all - push @args, '-a'; - } - } - } - else { - unsupportedRequestType(); - } - - push @{$request->{arg}}, @args; - my $req = genRequest(); - $responses = sendRequest($req); - - return $responses; -} - -sub networksHandler { - my $responses; - my @args; - my $netname = ''; - - if (isGet()) { - $request->{command} = 'lsdef'; - push @{$request->{arg}}, '-t', 'network'; - if (defined($path[1])) { - push @{$request->{arg}}, '-o', $path[1]; - } - my @temparray = $q->param('field'); - - #add the field name to get - if (scalar(@temparray) > 0) { - push @{$request->{arg}}, '-i'; - push @{$request->{arg}}, join(',', @temparray),; - } - } - elsif (isPut() || isPost()) { - my $entries; - my $iscommand = 0; + } elsif ($params->{'resourcename'} eq "beacon") { if (isPut()) { - $request->{command} = 'chdef'; - if (defined($path[1])) { - if ($path[1] eq "makehosts" || $path[1] eq "makedns") { - # Issue makehost/makedns directly - $request->{command} = $path[1]; - $iscommand = 1; - } + push @args, $paramhash->{'action'}; + } + } elsif ($params->{'resourcename'} eq "filesyncing") { + push @args, '-F'; + } elsif ($params->{'resourcename'} eq "software_maintenance") { + push @args, '-S'; + } elsif ($params->{'resourcename'} eq "postscript") { + push @args, '-P'; + if (defined ($paramhash->{'scripts'})) { + push @args, join (',', @{$paramhash->{'scripts'}}); + } + } elsif ($params->{'resourcename'} eq "nodeshell") { + if (defined ($paramhash->{'command'})) { + if (ref($paramhash->{'command'}) eq "ARRAY") { + push @args, join (';', @{$paramhash->{'command'}}); + } else { + push @args, $paramhash->{'command'}; } + } else { + error ("Lack of operation data.",$STATUS_BAD_REQUEST,3); } - else { - $request->{command} = 'mkdef'; + } elsif ($params->{'resourcename'} eq "nodecopy") { + if (defined ($paramhash->{'src'})) { + push @args, @{$paramhash->{'src'}}; } - - if (!$iscommand) { - if (defined $path[1]) { - $netname = $path[1]; - } - - if ($netname eq '') { - addPageContent('A network name must be specified.'); - sendResponseMsg($STATUS_BAD_REQUEST); - } - - push @{$request->{arg}}, '-t', 'network', '-o', $netname; - - if (!scalar(keys(%$paramhash))) { - error("No Field and Value map was supplied.",$STATUS_BAD_REQUEST); - } - - foreach my $k (keys(%$paramhash)) { - push @{$request->{arg}}, "$k=" . $paramhash->{$k}; - } + if (defined ($paramhash->{'target'})) { + push @args, $paramhash->{'target'}; } - } - elsif (isDelete()) { - $request->{command} = 'rmdef'; - - if (defined $path[1]) { - $netname = $path[1]; - } - if ($netname eq '') { - error('A network name must be specified.',$STATUS_BAD_REQUEST); - } - push @{$request->{arg}}, '-t', 'network', '-o', $netname; - } - else { - unsupportedRequestType(); - } - $responses = sendRequest(genRequest()); - - return $responses; -} - -#complete, unless there is some way to alter existing notifications -sub notificationsHandler { - my $responses; - my @args; - - my @notificationFields = ('filename', 'tables', 'tableops', 'comments', 'disable'); - - #does not support using the notification fileName in the URI - - if (isGet()) { - if (defined $q->param('fileName')) { - $request->{command} = 'gettab'; - push @args, "filename" . $q->param('fileName'); - - #if they specified the fields, just get those - if (defined $q->param('field')) { - foreach ($q->param('field')) { - push @args, $_; - } - } - - #else show all of the fields - else { - foreach (@notificationFields) { - push @args, "notification.$_"; - } - } - } - else { - $request->{command} = 'tabdump'; - push @args, "notification"; - } - } - elsif (isPost()) { - $request->{command} = 'regnotif'; - if (!defined $q->param('fileName') || !defined $q->param('table') || !defined $q->param('operation')) { - addPageContent("fileName, table and operation must be specified for a POST on /notifications"); - sendResponseMsg($STATUS_BAD_REQUEST); - } - else { - push @args, $q->param('fileName'); - my $tables; - foreach ($q->param('table')) { - $tables .= "$_,"; - } - - #get rid of the extra comma - chop($tables); - push @args, $tables; - push @args, '-o'; - my $operations; - foreach ($q->param('operation')) { - $operations .= "$_,"; - } - - #get rid of the extra comma - chop($operations); - push @args, $q->param('operation'); - } - } - elsif (isDelete()) { - $request->{command} = 'unregnotif'; - if (defined $q->param('fileName')) { - push @args, $q->param('fileName'); - } - else { - addPageContent("fileName must be specified for a DELETE on /notifications"); - sendResponseMsg($STATUS_BAD_REQUEST); - } - } - else { - unsupportedRequestType(); - } - - push @{$request->{arg}}, @args; - addPageContent("request is " . Dumper($request)); - my $req = genRequest(); - $responses = sendRequest($req); - - return $responses; -} - -#complete -sub policiesHandler { - my $responses; - my @args; - my $priority; - - my @policyFields = - ('priority', 'name', 'host', 'commands', 'noderange', 'parameters', 'time', 'rule', 'comments', 'disable'); - - #does it specify the prioirty in the URI? - if (defined $path[1]) { - $priority = $path[1]; - } - - #in the query string? - elsif (defined $q->param('priority')) { - $priority = $q->param('priority'); - } - - if (isGet()) { - if (defined $priority) { - $request->{command} = 'gettab'; - push @args, "priority=$priority"; - my @fields = $q->param('field'); - - #if they specified fields to retrieve - if (@fields) { - push @args, @fields; - } - - #give them everything if nothing is specified - else { - foreach (@policyFields) { - push @args, "policy.$_"; - } - } - } - else { - $request->{command} = 'tabdump'; - push @args, 'policy'; - } - } - elsif (isPost()) { - if (defined $priority) { - $request->{command} = 'tabch'; - push @args, "priority=$priority"; - for ($q->param) { - if ($_ ne /priority/) { - push @args, "policy.$_=" . $q->param($_); - } - } - } - - #some response about the priority being required - else { - addPageContent("The priority must be specified when creating a policy"); - sendResponseMsg($STATUS_BAD_REQUEST); - } - } - elsif (isDelete()) { - - #just allowing a delete by priority at the moment, could expand this to anything - if (defined $priority) { - $request->{command} = 'tabch'; - push @args, '-d'; - push @args, "priority=$priority"; - push @args, "policy"; - } - } - elsif (isPut() || isPatch()) { - if (defined $priority) { - $request->{command} = 'tabch'; - push @args, "priority=$priority"; - for ($q->param) { - if ($_ ne /priority/) { - push @args, "policy.$_=" . $q->param($_); - } - } - } - - #some response about the priority being required - else { - addPageContent("The priority must be specified when updating a policy"); - sendResponseMsg($STATUS_BAD_REQUEST); - } - } - else { - unsupportedRequestType(); - } - - push @{$request->{arg}}, @args; - addPageContent("request is " . Dumper($request)); - my $req = genRequest(); - $responses = sendRequest($req); - - return $responses; -} - -#complete -sub siteHandler { - my @data; - my $responses; - my @args; - - if (isGet()) { - $request->{command} = 'lsdef'; - push @{$request->{arg}}, '-t', 'site', '-o', 'clustersite'; - my @temparray = $q->param('field'); - - #add the field name to get - if (scalar(@temparray) > 0) { - push @{$request->{arg}}, '-i'; - push @{$request->{arg}}, join(',', @temparray); - } - } - elsif (isPut()) { - $request->{command} = 'chdef'; - push @{$request->{arg}}, '-t', 'site', '-o', 'clustersite'; - if (scalar(keys(%$paramhash))) { - foreach my $k (keys(%$paramhash)) { - push @{$request->{arg}}, "$k=".$paramhash->{$k}; - } - } - else { - error("No Field and Value map was supplied.",$STATUS_BAD_REQUEST); - } - } - else { - unsupportedRequestType(); - } - - my $req = genRequest(); - $responses = sendRequest($req); - return $responses; -} - -#provide direct table access -#complete and tested on the site table -#use of the actual DELETE doesn't seem to fit here, since a resource would not be deleted -#using PUT or PATCH instead, though it doesn't feel all that correct either -#todo: this should use the xcatd xml api that lissa implemented for pcm -sub tablesHandler { - my $responses; - my $table; - my @args; - - #is the table name specified in the URI? - if (defined $path[1]) { - $table = $path[1]; - } - - #handle all gets - if (isGet()) { - - #table was specified - if (defined $table) { - #todo: the input format needs to change - if (defined($paramhash->{col})) { - $request->{command} = 'gettab'; - push @args, $paramhash->{col} . '=' . $paramhash->{value}; - my @temparray = $paramhash->{attribute}; - foreach (@temparray) { - push @args, $table . '.' . $_; - } - } - else { - $request->{command} = 'tabdump'; - push @args, $table; - if (!defined($paramhash->{desc})) { - $formatType = 'splitCommas'; - } - } - } - else { - $request->{command} = 'tabdump'; - } - } - elsif (isPut() || isPatch()) { - my $condition = $paramhash->{condition}; - if (!defined $condition) { - #todo: the input format needs to change - if (scalar(keys(%$paramhash)) < 1) { - error("No set attribute was supplied.",$STATUS_BAD_REQUEST); - } - } - - if (!defined $table || !defined $condition) { - if (scalar(keys(%$paramhash)) < 1) { - error("The table and condition must be specified when adding, changing or deleting an entry",$STATUS_BAD_REQUEST); - } - } - $request->{command} = 'tabch'; - - if (defined($paramhash->{delete})) { - push @args, '-d'; - push @args, $condition; - push @args, $table; - } - elsif (defined $condition) { - push @args, $condition; - if ($paramhash->{value}) { - for ($paramhash->{value}) { - push @args, "$table.$_"; - } - } - } - else { - foreach my $k (keys(%$paramhash)) { - push @args, ($k, $paramhash->{$k}); - } - } - } - else { - unsupportedRequestType(); - } - - push @{$request->{arg}}, @args; - my $req = genRequest(); - $responses = sendRequest($req); - return $responses; -} - -#done aside from being able to change cluster users, which xcat can't do yet -sub accountsHandler { - my $responses; - my @args; - my $key = $q->param('key'); - - my @accountFields = ('key', 'username', 'password', 'cryptmethod', 'comments', 'disable'); - - if (isGet()) { - - #passwd table - if (!defined $q->param('clusterUser')) { - if (defined $key) { - $request->{command} = 'tabget'; - push @args, "key=$key"; - if (defined $q->param('field')) { - foreach ($q->param('field')) { - push @args, "passwd.$_"; - } - } - else { - foreach (@accountFields) { - push @args, "passwd.$_"; - } - } - } - else { - $request->{command} = 'tabdump'; - push @args, 'passwd'; - } - } - - #cluster user list - else { - $request->{command} = 'xcatclientnnr'; - push @args, 'clusteruserlist'; - push @args, '-p'; - } - } - elsif (isPost()) { - if (!defined $q->param('clusterUser')) { - if (defined $key) { - $request->{command} = 'tabch'; - push @args, "key=$key"; - for ($q->param) { - if ($_ !~ /key/) { - push @args, "passwd.$_=" . $q->param($_); - } - } - } - else { - addPageContent("The key must be specified when creating a non-cluster user"); - sendResponseMsg($STATUS_BAD_REQUEST); - } - } - - #active directory user - else { - #todo: should this really be using the same userName that is used to run the api call? - if (defined($generalparams->{userName}) && defined($paramhash->{userPass})) { - $request->{command} = 'xcatclientnnr'; - push @args, 'clusteruseradd'; - push @args, $generalparams->{userName}; - push @{$request->{arg}}, @args; - $request->{environment} = {XCAT_USERPASS => $paramhash->{userPass}}; - } - else { - addPageContent("The key must be specified when creating a cluster user"); - sendResponseMsg($STATUS_BAD_REQUEST); - } - } - } - elsif (isDelete()) { - if (!defined $q->param('clusterUser')) { - - #just allowing a delete by key at the moment, could expand this to anything - if (defined $key) { - $request->{command} = 'tabch'; - push @args, '-d'; - push @args, "key=$key"; - push @args, "passwd"; - } - else { - addPageContent("The key must be specified when deleting a non-cluster user"); - sendResponseMsg($STATUS_BAD_REQUEST); - } - } - else { - if (defined($generalparams->{userName})) { - $request->{command} = 'xcatclientnnr'; - push @args, 'clusteruserdel'; - push @args, $generalparams->{userName}; - } - else { - addPageContent("The userName must be specified when deleting a cluster user"); - sendResponseMsg($STATUS_BAD_REQUEST); - } - } - } - elsif (isPut() || isPatch()) { - if (!defined $q->param('clusterUser')) { - if (defined $key) { - $request->{command} = 'tabch'; - push @args, "key=$key"; - for ($q->param) { - if ($_ !~ /key/) { - push @args, "passwd.$_=" . $q->param($_); - } - } - } - else { - addPageContent("The key must be specified when updating a non-cluster user"); - sendResponseMsg($STATUS_BAD_REQUEST); - } - } - - #TODO: there isn't currently a way to update cluster users - else { - - } - } - else { - unsupportedRequestType(); - } - - push @{$request->{arg}}, @args; - my $req = genRequest(); - $responses = sendRequest($req); - return $responses; -} - -sub objectsHandler { - my $responses; - my @args; - my @objectTypeList = ( - "auditlog", "boottarget", "eventlog", "firmware", "group", "monitoring", - "network", "node", "notification", "osimage", "policy", "route", - "site"); - - #my %objectTypes; - #foreach my $item (@objectTypeList) { $objectTypes{$item} = 1 } - my @objectTypes; - my @objects; - if (defined $path[1]) { - $objectTypes[0] = $path[1]; - if (defined $path[2]) { - $objects[0] = $path[2]; - } - } - if (defined $q->param('objectType')) { - @objectTypes = $q->param('objectType'); - } - if (defined $q->param('object')) { - @objects = $q->param('object'); - } - - if ($q->param('verbose')) { - push @args, '-v'; - } - - if (isGet()) { - if (defined $objectTypes[0]) { - $request->{command} = 'lsdef'; - push @args, '-l'; - push @args, '-t'; - push @args, join(',', @objectTypes); - if (defined $objects[0]) { - push @args, '-o'; - push @args, join(',', @objects); - } - if ($q->param('info')) { - push @args, '-h'; - } - } - else { - if ($q->param('info')) { - push @args, '-h'; - } - else { - - #couldn't find a way to do this through xcatd, so shortcutting the request - my %resp = (data => \@objectTypeList); - return (\%resp); - } - } - } - elsif (isPut()) { - $request->{command} = 'chdef'; - if ($q->param('verbose')) { - push @args, '-v'; - } - if (!defined $q->param('objectType')) { - addPageContent("The object must be specified."); - sendResponseMsg($STATUS_BAD_REQUEST); - } - else { - push @args, '-t'; - push @args, join(',', $q->param('objectType')); - } - if ($q->param('objectName')) { - push @args, join(',', $q->param('objectName')); - } - if ($q->param('dynamic')) { + } elsif ($params->{'resourcename'} =~ /(dns|dhcp)/) { + if (isDelete()) { push @args, '-d'; } - if ($q->param('minus')) { - push @args, '-m'; + } elsif ($params->{'resourcename'} eq "subnodes") { + if (isGET()) { + push @args, '-z'; } - if ($q->param('plus')) { - push @args, '-p'; - } - if (defined $q->param('field')) { - foreach ($q->param('field')) { + } - #if it has ==, !=. =~ or !~ operators in the field, use the -w option - if (/==|!=|=~|!~/) { - push @args, '-w'; - } - push @args, $_; - } - } - if ($q->param('nodeRange')) { - push @args, $q->param('nodeRange'); - } - - } - elsif (isPost()) { - $request->{command} = 'mkdef'; - if ($q->param('verbose')) { - push @args, '-v'; - } - if (!defined $q->param('objectType')) { - addPageContent("The object must be specified."); - sendResponseMsg($STATUS_BAD_REQUEST); - } - else { - push @args, '-t'; - push @args, join(',', $q->param('objectType')); - } - if ($q->param('objectName')) { - push @args, join(',', $q->param('objectName')); - } - if ($q->param('dynamic')) { - push @args, '-d'; - } - if ($q->param('force')) { - push @args, '-f'; - } - if (defined $q->param('field')) { - foreach ($q->param('field')) { - - #if it has ==, !=. =~ or !~ operators in the field, use the -w option - if (/==|!=|=~|!~/) { - push @args, '-w'; - } - push @args, $_; - } - } - if ($q->param('nodeRange')) { - push @args, $q->param('nodeRange'); - } - - } - elsif (isDelete()) { - $request->{command} = 'rmdef'; - if (defined $q->param('info')) { - push @args, '-h'; - } - elsif (defined $q->param('all')) { - push @args, '-a'; - } - elsif (defined $objectTypes[0]) { - push @args, '-t'; - push @args, join(',', @objectTypes); - if (defined $objects[0]) { - push @args, '-o'; - push @args, join(',', @objects); - } - } - else { - addPageContent( -"Either the help info must be requested or the object must be specified or the flag that indicates everything should be removed." - ); - sendResponseMsg($STATUS_BAD_REQUEST); - } - if (defined $q->param('nodeRange')) { - push @args, $q->param('nodeRange'); - } - } - else { - unsupportedRequestType(); - } - - push @{$request->{arg}}, @args; + push @{$request->{arg}}, @args; my $req = genRequest(); - $responses = sendRequest($req); + my $responses = sendRequest($req); + return $responses; } -#complete i think, tho chvm could handle args better -sub vmsHandler { +# The operation callback subroutine for node irrelevant commands like makedns -n and makedhcp -n +# assembe the xcat request, send it to xcatd and get response +sub nonobjhdl { + my $params = shift; + my @args; - my $noderange; - my $subResource; - if (defined $path[1]) { - $noderange = $path[1]; - $request->{noderange} = $noderange; - } - else { - addPageContent("Invalid nodes and/or groups in noderange"); - sendResponseMsg($STATUS_BAD_REQUEST); - } + my @urilayers = @{$params->{'layers'}}; - if (isGet()) { - $request->{command} = 'lsvm'; - if (defined $q->param('all')) { - push @args, '-a'; + # set the command name + $request->{command} = $params->{'cmd'}; + if ($params->{'resourcename'} =~ /(dns|dhcp)/) { + push @args, '-n'; + } elsif ($params->{'resourcename'} eq "slpnodes") { + if (isGET()) { + push @args, '-z'; } - - # for z/VM - if (defined $q->param('networknames')) { - push @args, '--getnetworknames'; + } elsif ($params->{'resourcename'} eq "specific_slpnodes") { + if (isGET()) { + push @args, "-z"; + push @args, "-s"; + push @args, $urilayers[2]; } - - if (defined $q->param('network')) { - push @args, '--getnetwork'; - push @args, $q->param('getnetwork'); - } - - if (defined $q->param('diskpoolnames')) { - push @args, '--diskpoolnames'; - } - - if (defined $q->param('diskpool')) { - push @args, '--diskpool'; - push @args, $q->param('diskpool'); + } elsif ($params->{'resourcename'} eq "tokens") { + $request->{gettoken}->[0]->{username}->[0] = $generalparams->{userName} if (defined($generalparams->{userName})); + $request->{gettoken}->[0]->{password}->[0] = $generalparams->{password} if (defined($generalparams->{password})); + } + + push @{$request->{arg}}, @args; + my $req = genRequest(); + my $responses = sendRequest($req); + + return $responses; +} + + +# operate image instance for a osimage +sub imgophdl { + my $params = shift; + my @args = (); + if (isPost()) { + if ($params->{'resourcename'} eq "osimage_op") { + my $action = $paramhash->{'action'}; + unless ($action) { + error("Missed Action.",$STATUS_NOT_FOUND); + } elsif ($action eq "gen") { + $params->{'cmd'} = "genimage"; + } elsif ($action eq "pack") { + $params->{'cmd'} = "packimage"; + } elsif ($action eq "export") { + $params->{'cmd'} = "imgexport"; + } else { + error("Incorrect action:$action.",$STATUS_BAD_REQUEST); + } + } elsif ($params->{'resourcename'} eq "osimage") { + if (exists($paramhash->{'iso'})) { + $params->{'cmd'} = "copycds"; + push @{$params->{layers}}, $paramhash->{'iso'}; + } elsif (exists($paramhash->{'file'})) { + $params->{'cmd'} = "imgimport"; + push @{$params->{layers}}, $paramhash->{'file'}; + } elsif (exists($paramhash->{'node'})) { + $params->{'cmd'} = "imgcapture"; + #push @{$params->{layers}}, $paramhash->{'node'}; + push @{$request->{noderange}}, $paramhash->{'node'}; + } else { + error("Invalid source.",$STATUS_NOT_FOUND); + } } } - elsif (isPost()) { - my $position; - $request->{command} = 'mkvm'; - unless (scalar(keys(%$paramhash))) { - error("no parameters specified", $STATUS_BAD_REQUEST); - } - - #for system p - if (defined $paramhash->{'cec'}) { - push @args, '-c'; - push @args, $paramhash->{'cec'}; - } - - if (defined $paramhash->{'startId'}) { - push @args, '-i'; - push @args, $paramhash->{'startId'}; - } - - if (defined $paramhash->{'source'}) { - push @args, '-l'; - push @args, $paramhash->{'source'}; - } - - if (defined $paramhash->{'profile'}) { - push @args, '-p'; - push @args, $paramhash->{'profile'}; - } - - if (defined $paramhash->{'full'}) { - push @args, '--full'; - } - - #for KVM & Vmware - if (defined $paramhash->{'master'}) { - push @args, '-m'; - push @args, $paramhash->{'master'}; - } - - if (defined $paramhash->{'disksize'}) { - push @args, '-s'; - push @args, $paramhash->{'disksize'}; - } - - if (defined $paramhash->{'memory'}) { - push @args, '--mem'; - push @args, $paramhash->{'memory'}; - } - - if (defined $paramhash->{'cpu'}) { - push @args, '--cpus'; - push @args, $paramhash->{'cpu'}; - } - - if (defined $paramhash->{'force'}) { - push @args, '-f'; - } - - # for z/VM - if (defined $paramhash->{'userid'}) { - push @args, '--userid'; - push @args, $paramhash->{'userid'}; - } - - if (defined $paramhash->{'size'}) { - push @args, '--size'; - push @args, $paramhash->{'size'}; - } - - if (defined $paramhash->{'password'}) { - push @args, '--password'; - push @args, $paramhash->{'password'}; - } - - if (defined $paramhash->{'privilege'}) { - push @args, '--privilege'; - push @args, $paramhash->{'privilege'}; - } - - if (defined $paramhash->{'diskpool'}) { - push @args, '--diskpool'; - push @args, $paramhash->{'diskpool'}; - } - - if (defined $paramhash->{'diskvdev'}) { - push @args, '--diskVdev'; - push @args, $paramhash->{'diskvdev'}; + $request->{command} = $params->{'cmd'}; + push @args, $params->{layers}->[1]; + if (exists($paramhash->{'params'})) { + foreach (keys %{$paramhash->{'params'}->[0]}) { + push @args, ($_, $paramhash->{'params'}->[0]->{$_}); } } - elsif (isPut()) { - $request->{command} = 'chvm'; - if (scalar(keys(%$paramhash)) < 1) { - error("No Field and Value map was supplied.", $STATUS_BAD_REQUEST); - } - foreach my $k (%$paramhash) { - push @args, ($k, $paramhash->{$k}); - } - } - elsif (isDelete()) { - $request->{command} = 'rmvm'; - if (defined $paramhash->{retain}) { - push @args, '-r'; - } - if (defined $paramhash->{service}) { - push @args, '--service'; - } - } - else { - unsupportedRequestType(); - } - - push @{$request->{arg}}, @args; - my $req = genRequest(); + push @{$request->{arg}}, @args; + my $req = genRequest(); my $responses = sendRequest($req); return $responses; } -sub versionHandler { - addPageContent($q->p("API version is $VERSION")); - sendResponseMsg($STATUS_OK); - exit(0); +sub sitehdl { + my $params = shift; + my @args; + my @urilayers = @{$params->{'layers'}}; + + # set the command name + $request->{command} = $params->{'cmd'}; + # push the -t args + push @args, '-t'; + push @args, 'site'; + if (isGET()) { + push @args, 'clustersite'; + } + if (defined ($urilayers[2])){ + if (isGET()) { + push @args, ('-i', $urilayers[2]); + } + } + if (isDelete()) { + if (defined ($urilayers[2])){ + push @args, "$urilayers[2]="; + } + } + foreach my $k (keys(%$paramhash)) { + push @args, "$k=$paramhash->{$k}" if ($k); + } + push @{$request->{arg}}, @args; + my $req = genRequest(); + my $responses = sendRequest($req); + + return $responses; } -sub hypervisorHandler { - my $responses; - my @args; - if (isPut()) { - if (defined $path[1]) { - $request->{noderange} = $path[1]; - } - else { - error("Invalid nodes and/or groups in node in noderange",$STATUS_BAD_REQUEST); - } - - if (defined $path[2]) { - $request->{command} = $path[2]; - } - else { - $request->{command} = 'chhypervisor'; - } - if (scalar(keys(%$paramhash)) < 1) { - error("No set attribute was supplied.",$STATUS_BAD_REQUEST); - } - - foreach my $k (keys(%$paramhash)) { - push @args, ($k, $paramhash->{$k}); - } - - push @{$request->{arg}}, @args; - my $req = genRequest(); - $responses = sendRequest($req); - return $responses; - } + +# get attrs of tables for a noderange +sub tablenodehdl { + my $params = shift; + + my @args; + my @urilayers = @{$params->{'layers'}}; + # the array elements for @urilayers are: + # 0 - 'table' + # 1 - + # 2 - 'nodes' + # 3 - (optional) + # 4 - (optional) + + # set the command name + my @tables = split(/,/, $urilayers[1]); + + if (!defined($urilayers[3]) || $urilayers[3] eq 'ALLNODES') { + $request->{command} = 'getTablesAllNodeAttribs'; + } else { + $request->{command} = 'getTablesNodesAttribs'; + $request->{noderange} = $urilayers[3]; + } + + # For both getTablesAllNodeAttribs and getTablesNodesAttribs, the rest of the request strucutre looks like this: + # table => [ + # { + # tablename => nodehm, + # attr => [ + # mgmt, + # cons + # ] + # }, + # { + # tablename => ipmi, + # attr => [ + # ALL + # ] + # } + # ] + + # if they specified attrs, sort/group them by table + my $attrlist = $urilayers[4]; + if (!defined($attrlist)) { $attrlist = 'ALL'; } # attr=ALL means get all non-blank attributes + my @attrs = split(/,/, $attrlist); + my %attrhash; + foreach my $a (@attrs) { + if ($a =~ /\./) { + my ($table, $attr) = split(/\./, $a); + push @{$attrhash{$table}}, $attr; + } + else { # the attr doesn't have a table qualifier so apply to all tables + foreach my $t (@tables) { push @{$attrhash{$t}}, $a; } + } + } + + # deal with all of the tables and the attrs for each table + foreach my $tname (@tables) { + my $table = { tablename => $tname }; + if (defined($attrhash{$tname})) { $table->{attr} = $attrhash{$tname}; } + else { $table->{attr} = 'ALL'; } + push @{$request->{table}}, $table; + } + + + my $req = genRequest(); + # disabling the KeyAttr option is important in this case, so xmlin doesn't pull the name attribute + # out of the node hash and make it the key + my $responses = sendRequest($req, {SuppressEmpty => undef, ForceArray => 0, KeyAttr => []}); + + return $responses; } -#for operations that take a 'long' time to finish, this will provide the interface to check their status -#todo: this is not supported in xcatd yet, so not sure what to do about this one -sub jobsHandler { + +# get attrs of tables for keys +sub tablerowhdl { + my $params = shift; + + my @args; + my @urilayers = @{$params->{'layers'}}; + # the array elements for @urilayers are: + # 0 - 'table' + # 1 - + # 2 - 'rows' + # 3 - (optional) + # 4 - (optional) + + # do stuff that is common between getAttribs and getTablesAllRowAttribs + my @tables = split(/,/, $urilayers[1]); + my $attrlist = $urilayers[4]; + if (!defined($attrlist)) { $attrlist = 'ALL'; } # attr=ALL means get all non-blank attributes + my @attrs = split(/,/, $attrlist); + + # get all rows for potentially multiple tables + if (!defined($urilayers[3]) || $urilayers[3] eq 'ALLROWS') { + $request->{command} = 'getTablesAllRowAttribs'; + # For getTablesAllRowAttribs, the rest of the request strucutre needs to look like this: + # table => [ + # { + # tablename => nodehm, + # attr => [ + # mgmt, + # cons + # ] + # }, + # { + # tablename => ipmi, + # attr => [ + # ALL + # ] + # } + # ] + + # if they specified attrs, sort/group them by table + my %attrhash; + foreach my $a (@attrs) { + if ($a =~ /\./) { + my ($table, $attr) = split(/\./, $a); + push @{$attrhash{$table}}, $attr; + } + else { # the attr doesn't have a table qualifier so apply to all tables + foreach my $t (@tables) { push @{$attrhash{$t}}, $a; } + } + } + + # deal with all of the tables and the attrs for each table + foreach my $tname (@tables) { + my $table = { tablename => $tname }; + if (defined($attrhash{$tname})) { $table->{attr} = $attrhash{$tname}; } + else { $table->{attr} = 'ALL'; } + push @{$request->{table}}, $table; + } + } + + # for 1 table, get just one row based on the keys given + else { + if (scalar(@tables) > 1) { error('currently you can only specify keys for a single table.', $STATUS_BAD_REQUEST); } + $request->{command} = 'getAttribs'; + # For getAttribs, the rest of the request strucutre needs to look like this: + # { + # table => networks, + # keys => { + # net => 11.35.0.0, + # mask => 255.255.0.0 + # } + # attr => [ + # netname, + # dhcpserver + # ] + # }, + $request->{table} = $tables[0]; + if (defined($urilayers[3])) { + my @keyvals = split(/,/, $urilayers[3]); + foreach my $kv (@keyvals) { + my ($key, $value) = split(/\s*=\s*/, $kv, 2); + $request->{keys}->{$key} = $value; + } + } + foreach my $a (@attrs) { push @{$request->{attr}}, $a; } + } + + my $req = genRequest(); + # disabling the KeyAttr option is important in this case, so xmlin doesn't pull the name attribute + # out of the node hash and make it the key + my $responses = sendRequest($req, {SuppressEmpty => undef, ForceArray => 0, KeyAttr => []}); + + return $responses; } -sub debugHandler { - my $responses; - my @args; - if (isPut()) { - $request->{command} = 'xcatclientnnr xcatdebug'; - - if (scalar(keys(%$paramhash)) < 1) { - error("No set attribute was supplied.",$STATUS_BAD_REQUEST); - } - - foreach (@{$paramhash->{xcatdebug}}) { - push @{$request->{arg}}, $_; - } - - push @{$request->{arg}}, @args; - my $req = genRequest(); - $responses = sendRequest($req); - return $responses; - } -} +# parse the output of all attrs of tables for the GET calls. This is used for both node-oriented tables +# and non-node-oriented tables. +#todo: investigate a converter straight from xml to json +sub tableout { + my $data = shift; + my $json = {}; + # For the table get calls, we turned off ForceArray and KeyAttr for XMLin(), so the output is a little + # different than usual. Each element is a hash with key "table" that is either a hash or array of hashes. + # Each element of that is a hash with 2 keys called "tablename" and "node". The latter has either: an array of node hashes, + # or (if there is only 1 node returned) the node hash directly. + # We are producing json that is a hash of table name keys that each have an array of node objects. + foreach my $d (@$data) { + my $table = $d->{table}; + if (!defined($table)) { # special case for the getAttribs cmd + $json->{$request->{table}}->[0] = $d; + last; + } + #debug(Dumper($d)); debug (Dumper($jsonnode)); + if (ref($table) eq 'HASH') { $table = [$table]; } # if a single table, make it a 1 element array of tables + foreach my $t (@$table) { + my $jsonnodes = []; # start an array of node objects for this table + my $tabname = $t->{tablename}; + if (!defined($tabname)) { $tabname = 'unknown' . $::i++; } #todo: have lissa fix this bug + $json->{$tabname} = $jsonnodes; # add it into the top level hash + my $node = $t->{node}; + if (!defined($node)) { $node = $t->{row}; } + #debug(Dumper($d)); debug (Dumper($jsonnode)); + if (ref($node) eq 'HASH') { $node = [$node]; } # if a single node, make it a 1 element array of nodes + foreach my $n (@$node) { push @$jsonnodes, $n; } + } + } + addPageContent($JSON->encode($json)); +} -# Format the output data the way the user requested. All data wrapping and writing is funneled through here. -# This will call one of the other wrap*() functions. -sub wrapData { +# set attrs of nodes in tables +sub tablenodeputhdl { + my $params = shift; + + # from the %URIdef: + # desc => "[URI:/tables/nodes/{noderange}] - Change the table attibutes for the {noderange}.", + # usage => "|An array of table objects. Each table object contains the table name and an object of attribute values. DataBody: {table1:{attr1:v1,att2:v2,...}}.|$usagemsg{non_getreturn}|", + # example => '|Change the nodehm.mgmt and noderes.netboot attributes for nodes node1-node5.|PUT|/tables/nodes/node1-node5 {"nodehm":{"mgmt":"ipmi"},"noderes":{"netboot":"xnba"}}||', + + my @args; + my @urilayers = @{$params->{'layers'}}; + # the array elements for @urilayers are: + # 0 - 'table' + # 1 - + # 2 - 'nodes' + # 3 - + + # set the command name + $request->{command} = 'setNodesAttribs'; + $request->{noderange} = $urilayers[3]; + + # For setNodesAttribs, the rest of the request strucutre looks like this: + # arg => { + # table => [ + # { + # name => nodehm, + # attr => { + # mgmt => ipmi + # } + # }, + # { + # name => noderes, + # attr => { + # netboot => xnba + # } + # } + # ] + # } + + # Get table list in the URI + my @uritbs = split(/,/, $urilayers[1]); + + # Go thru the list of tables (which are the top level keys in paramhash) + my $tables = []; + $request->{arg}->{table} = $tables; + foreach my $k (keys(%$paramhash)) { + my $intable = $k; + # Check the validity of tables + if (! grep(/^$intable$/, @uritbs)) { + error("The table $intable is NOT in the URI.", $STATUS_BAD_REQUEST); + } + my $attrhash = $paramhash->{$k}; + my $outtable = { name=>$intable, attr=>$attrhash }; + push @$tables, $outtable; + } + + my $req = genRequest(); + # disabling the KeyAttr option is important in this case, so xmlin doesn't pull the name attribute + # out of the node hash and make it the key + my $responses = sendRequest($req, {SuppressEmpty => undef, ForceArray => 1, KeyAttr => []}); + + return $responses; +} + +# set attrs of a row in a non-node table +sub tablerowputhdl { + my $params = shift; + + # from %URIdef: + # desc => "[URI:/tables/{table}/rows/{keys}] - Change the non-node table attibutes for the row that matches the {keys}.", + # usage => "|A hash of attribute names and values. DataBody: {attr1:v1,att2:v2,...}.|$usagemsg{non_getreturn}|", + # example => '|Creat a route row in the routes table.|PUT|/tables/routes/rows/routename=privnet {"net":"10.0.1.0","mask":"255.255.255.0","gateway":"10.0.1.254","ifname":"eth1"}||', + + my @args; + my @urilayers = @{$params->{'layers'}}; + # the array elements for @urilayers are: + # 0 - 'table' + # 1 - + # 2 - 'rows' + # 3 - + + # set the command name + $request->{command} = 'setAttribs'; + + # For setAttribs, the rest of the xml request strucutre looks like this: + # routes
+ # + # foo + # + # + # 10.0.1.0 + # This is a test + # + + # set the table name and keys + $request->{table} = $urilayers[1]; + my @keyvals = split(/,/, $urilayers[3]); + foreach my $kv (@keyvals) { + my ($key, $value) = split(/\s*=\s*/, $kv, 2); + $request->{keys}->{$key} = $value; + } + + # the attribute/value hash is already in paramhash + $request->{attr} = $paramhash; + + my $req = genRequest(); + # disabling the KeyAttr option is important in this case, so xmlin doesn't pull the name attribute + # out of the node hash and make it the key + my $responses = sendRequest($req, {SuppressEmpty => undef, ForceArray => 1, KeyAttr => []}); + + return $responses; +} + +# delete rows in a non-node table +sub tablerowdelhdl { + my $params = shift; + + # from %URIdef: + # desc => "[URI:/tables/{table}/rows/{attrvals}] - Delete rows from a non-node table that have the attribute values specified in {attrvals}.", + # usage => "||$usagemsg{non_getreturn}|", + # example => '|Delete a route row in the routes table.|PUT|/tables/routes/rows/routename=privnet||', + + my @args; + my @urilayers = @{$params->{'layers'}}; + # the array elements for @urilayers are: + # 0 - 'table' + # 1 - + # 2 - 'rows' + # 3 - + + # set the command name + $request->{command} = 'delEntries'; + + # For delEntries, the rest of the xml request strucutre looks like this: + # + # nodelist + # + # compute1,lissa + # down + # + #
+ + # set the table name and attr/vals + my $table = {}; # will hold the name and attr/vals + $request->{table}->[0] = $table; #todo: the xcat delEntries cmd supports multiple tables in 1 request. We could support this if the attr names were table.attr + $table->{name} = $urilayers[1]; + my @attrvals = split(/,/, $urilayers[3]); + foreach my $av (@attrvals) { + my ($attr, $value) = split(/\s*=\s*/, $av, 2); + $table->{attr}->{$attr} = $value; + } + + my $req = genRequest(); + # disabling the KeyAttr option is important in this case, so xmlin doesn't pull the name attribute + # out of the node hash and make it the key + my $responses = sendRequest($req, {SuppressEmpty => undef, ForceArray => 1, KeyAttr => []}); + + return $responses; +} + + +# display the resource list when run 'xcatws.cgi -d' +sub displayUsage { + foreach my $group (keys %URIdef) { + print "Resource Group: $group\n"; + foreach my $res (keys %{$URIdef{$group}}) { + print " Resource: $res\n"; + print " $URIdef{$group}->{$res}->{desc}\n"; + if (defined ($URIdef{$group}->{$res}->{GET})) { + print " GET: $URIdef{$group}->{$res}->{GET}->{desc}\n"; + } + if (defined ($URIdef{$group}->{$res}->{PUT})) { + print " PUT: $URIdef{$group}->{$res}->{PUT}->{desc}\n"; + } + if (defined ($URIdef{$group}->{$res}->{POST})) { + print " POST: $URIdef{$group}->{$res}->{POST}->{desc}\n"; + } + if (defined ($URIdef{$group}->{$res}->{DELETE})) { + print " DELETE: $URIdef{$group}->{$res}->{DELETE}->{desc}\n"; + } + } + } +} + + +# This handles and removes serverdone and error tags in the perl data structure that is from the xml that xcatd returned +#bmp: is there a way to avoid make a copy of the whole response? For big output that could be time consuming. +# For the error tag, you don't have to bother copying the response, because you are going to exit anyway. +# Maybe this function could just verify there is a serverdone and handle any error, and then +# let each specific output handler ignore the serverdone tag? + +# Filter out the error message +# If has 'error' message in the output data, push them all to one list +# If has 'errorcode' in the output data, set it to be the errorcode of response. Otherwise, the errorcode to '1' +# When get the 'serverdone' identifer +# If 'errorcode' has been set, return the error message and error code like {error:[msg1,msg2...], errorcode:num} +# Otherwise, pass the output to the outputhandler for the specific resource + +sub filterData { my $data = shift; - my $errorInformation = ''; + #debugandexit(Dumper($data)); + my $outputdata; + my $outputerror; + my @errmsgindata; # put the out->{data} for error message output + #trim the serverdone message off - if (exists $data->[0]->{serverdone} && exists $data->[0]->{error}) { - $errorInformation = $data->[0]->{error}->[0]; - addPageContent($q->p($errorInformation)); #todo: put this in the requested format? - if (($errorInformation =~ /Permission denied/) || ($errorInformation =~ /Authentication failure/)) { - sendResponseMsg($STATUS_UNAUTH); + foreach (@{$data}) { + if (defined($_->{error})) { + if (ref($_->{error}) eq 'ARRAY') { + foreach my $msg (@{$_->{error}}) { + if ($msg =~ /(Permission denied|Authentication failure)/) { + # return 401 Unauthorized + sendResponseMsg($STATUS_UNAUTH); + } else { + push @{$outputerror->{error}}, $msg; + } + } + } else { + push @{$outputerror->{error}}, $_->{error}; + } + + if (defined ($_->{errorcode})) { + if (ref($_->{errorcode}) eq 'ARRAY') { + $outputerror->{errorcode} = $_->{errorcode}->[0]; + } else { + $outputerror->{errorcode} = $_->{errorcode}; + } + } else { + # set the default errorcode to '1' + $outputerror->{errorcode} = '1'; + } + } elsif (defined($_->{errorcode}) && $_->{errorcode}->[0] ne "0") { # defined errorcode, but not define the error msg + $outputerror->{errorcode} = $_->{errorcode}->[0]; + if (defined ($_->{data}) && ref($_->{data}->[0]) ne "HASH") { + # to get the message in data for the case that errorcode is set but no 'error' attr + push @errmsgindata, $_->{data}->[0]; + } + if (@errmsgindata) { + push @{$outputerror->{error}}, @errmsgindata; + } else { + push @{$outputerror->{error}}, "Failed with unknown reason."; + } } - else { - sendResponseMsg($STATUS_FORBIDDEN); - } - } - else { - pop @{$data}; #todo: are we sure this is the serverdone entry? + + # handle the output like + # + # node1 + # Unable to identify plugin for this command, check relevant tables: nodehm.power,mgt;nodehm.mgt + # 1 + # + if (defined($_->{node}) && defined ($_->{node}->[0]->{error})) { + if (defined ($_->{node}->[0]->{name})) { + push @{$outputerror->{error}}, "$_->{node}->[0]->{name}->[0]: ".$_->{node}->[0]->{error}->[0]; + } + if (defined ($_->{node}->[0]->{errorcode})) { + $outputerror->{errorcode} = $_->{node}->[0]->{errorcode}->[0]; + } else { + # set the default errorcode to '1' + $outputerror->{errorcode} = '1'; + } + } + + + if (exists($_->{serverdone})) { + if (defined ($outputerror->{error}) || defined ($outputerror->{error})) { + addPageContent($JSON->encode($outputerror)); + #return the default http error code to be 403 forbidden + sendResponseMsg($STATUS_FORBIDDEN); + #} else { + #otherwise, ignore the 'servicedone' data + # next; + } else { + delete ($_->{serverdone}); + if (scalar(keys %{$_}) > 0) { + push @{$outputdata}, $_; + } + } + } else { + if (defined ($_->{data}) && ref($_->{data}->[0]) ne "HASH") { + # to get the message in data for the case that errorcode is set but no 'error' attr + push @errmsgindata, $_->{data}->[0]; + } + push @{$outputdata}, $_; + } } - # Call the appropriate formatting function stored in the formatters hash - if (exists $formatters{$format}) { - $formatters{$format}->($data); - } - - # all output has been added into the global varibale pageContent, now complete the response to the user - if (exists $data->[0]->{info} && $data->[0]->{info}->[0] =~ /Could not find an object/) { - sendResponseMsg($STATUS_NOT_FOUND); - } - elsif (isPost()) { - sendResponseMsg($STATUS_CREATED); - } - else { - sendResponseMsg($STATUS_OK); - } + return $outputdata; } - # Structure the response perl data structure into well-formed json. Since the structure of the # xml output that comes from xcatd is inconsistent and not very structured, we have a lot of work to do. sub wrapJson { # this is an array of responses from xcatd. Often all the output comes back in 1 response, but not always. my $data = shift; + addPageContent($JSON->encode($data)); + return; + + # put, delete, and patch usually just give a short msg, if anything if (isPut() || isDelete() || isPatch()) { addPageContent($JSON->encode($data)); return; } - - if ($resource eq 'nodes') { wrapJsonNodes($data); } - else { addPageContent($JSON->encode($data)); } #todo: implement wrappers for each of the resources } +# Append content to the global var holding the output to go back to the rest client +# 1st param - The output message +# 2nd param - A flag to specify the format of 1st param: 1 - json formatted standard xcat output data +sub addPageContent { + my $newcontent = shift; + my $userdata = shift; -# structure the json output for node resource api calls -sub wrapJsonNodes { - # this is an array of responses from xcatd. Often all the output comes back in 1 response, but not always. - my $data = shift; - - # Divide the processing into several groups of requests, according to how they return the output - # At this point, these are all gets and posts. The others were taken care of wrapJson() - my $json; - if (isGet()) { - if (!defined $path[2] && !defined($paramhash->{field})) { # querying node list - # The data structure is: array of hashes that have a single key 'node'. The value for that key - # is an array of hashes with a single key 'name'. The value for that key - # is a 1-element array that contains the node name. - # Create a json array of node name strings. - $json = []; - foreach my $d (@$data) { - my $ar = $d->{node}; - foreach my $a (@$ar) { - my $nodename = $a->{name}->[0]; - if (!defined($nodename)) { error('improperly formatted lsdef output from xcatd', $STATUS_TEAPOT); } - push @$json, $nodename; - } - } - addPageContent($JSON->encode($json)); - } - elsif (!defined $path[2] && defined($paramhash->{field})) { # querying node attributes - # The data structure is: array of hashes that have a single key 'info'. The value for that key - # is an array of lines of lsdef output (all nodes in the same array). - # Create a json array of node objects. Each node object contains the attributes/values (including - # the nodename) of that object. - $json = []; - foreach my $d (@$data) { - my $jsonnode; - my $lines = $d->{info}; - foreach my $l (@$lines) { - if ($l =~ /^Object name: /) { # start new node - if (defined($jsonnode)) { push @$json, $jsonnode; } # push previous object onto array - my ($nodename) = $l =~ /^Object name:\s+(\S+)/; - $jsonnode = { nodename => $nodename }; + if ($userdata && $XCOLL) { + my $group; + my $hash = $JSON->decode($newcontent); + if (ref($hash) eq "HASH") { + foreach my $node (keys %{$hash}) { + if (ref($hash->{$node}) eq "HASH") { + my $value; + foreach (sort (keys %{$hash->{$node}})) { + $value .= "$_$hash->{$node}->{$_}"; } - else { # just an attribute of the current node - if (!defined($jsonnode)) { error('improperly formatted lsdef output from xcatd', $STATUS_TEAPOT); } - my ($attr, $val) = $l =~ /^\s*(\S+)=(.*)$/; - if (!defined($attr)) { error('improperly formatted lsdef output from xcatd', $STATUS_TEAPOT); } - $jsonnode->{$attr} = $val; + push @{$group->{$value}->{node}}, $node; + $group->{$value}->{orig} = $hash->{$node}; + } elsif (ref($hash->{$node}) eq "ARRAY") { + my $value; + foreach (sort (@{$hash->{$node}})) { + $value .= "$_"; } + push @{$group->{$value}->{node}}, $node; + $group->{$value}->{orig} = $hash->{$node}; } - if (defined($jsonnode)) { push @$json, $jsonnode; $jsonnode=undef; } # push last object onto array - } - addPageContent($JSON->encode($json)); - } - elsif (grep(/^$path[2]$/, qw(power inventory vitals energy status))) { # querying other node info - # The data structure is: array of hashes that have a single key 'node'. The value for that key - # is a 1-element array that has a hash with keys 'name' and 'data'. The 'name' value is a 1-element - # array that has the nodename. The 'data' value is a 1-element array of a hash that has keys 'desc' - # and 'content' (sometimes desc is ommited), or in the case of status it has the status directly in the array. - # Create a json array of node objects. Each node object contains the attributes/values (including - # the nodename) of that object. - $json = {}; # its keys are nodenames - foreach my $d (@$data) { - # each element is a complex structure that contains 1 attr and value for a node - my $node = $d->{node}->[0]; - my $nodename = $node->{name}->[0]; - my $nodedata = $node->{data}->[0]; - if ($path[2] eq 'status') { - $json->{$nodename} = $nodedata; - } - else { - my $contents = $nodedata->{contents}->[0]; - my $desc = 'power'; # rpower doesn't output a desc tag - if (defined($nodedata->{desc})) { $desc = $nodedata->{desc}->[0]; } - # add this desc and content into this node's hash - $json->{$nodename}->{$desc} = $contents; - } - } - if ($path[2] eq 'status') { addPageContent($JSON->encode($json)); } - else { - # convert this hash of hashes into an array of hashes - my @jsonarray; - foreach my $n (sort(keys(%$json))) { - $json->{$n}->{nodename} = $n; # add the key (nodename) inside of the node's hash - push @jsonarray, $json->{$n}; - } - addPageContent($JSON->encode(\@jsonarray)); } } - else { # querying a node subresource (rpower, rvitals, rinv, etc.) - addPageContent($JSON->encode($data)); - } # end else path[2] defined + my $groupout; + foreach my $value (keys %{$group}) { + if (defined $group->{$value}->{node}) { + my $nodes = join(',', @{$group->{$value}->{node}}); + if (defined ($group->{$value}->{orig})) { + $groupout->{$nodes} = $group->{$value}->{orig}; + } + } + } + $newcontent = $JSON->encode($groupout) if ($groupout); } - elsif (isPost()) { # dsh or dcp - if ($path[2] eq 'dsh') { - # The data structure is: array of hashes with a single key, either 'data' or 'errorcode'. The value - # of 'errorcode' is a 1-element array containing the error code. The value of 'data' is an array of - # output lines prefixed by the node name. Some of the lines can be null. - # Create a hash with 2 keys: 'errorcode' and 'nodes'. The 'nodes' value is a hash of nodenames, each - # value is an array of the output for that node. - $json = {}; # its keys are nodenames - foreach my $d (@$data) { - # this is either an errorcode hash or data hash - if (defined($d->{errorcode})) { - $json->{errorcode} = $d->{errorcode}->[0]; - } - elsif (defined($d->{data})) { - foreach my $line (@{$d->{data}}) { - my ($nodename, $output) = $line =~ m/^(\S+): (.*)$/; - if (defined($nodename)) { push @{$json->{$nodename}}, $output; } - } - } - else { error('improperly formatted xdsh output from xcatd', $STATUS_TEAPOT); } - } - addPageContent($JSON->encode($json)); - } - elsif ($path[2] eq 'dcp') { - # The data structure is a 1-element array of a hash with 1 key 'errorcode'. That has a 1-element - # array with the code in it. Let's simplify it. - $json->{errorcode} = $data->[0]->{errorcode}->[0]; - addPageContent($JSON->encode($json)); - } - else { - addPageContent($JSON->encode($data)); - } - } # end if isPost + + $pageContent .= $newcontent; } - -sub wrapHtml { - my $item; - my $response = shift; - - foreach my $element (@$response) { - - if ($element->{node}) { - addPageContent(""); - foreach $item (@{$element->{node}}) { - - #my $url = $baseUri.$item->{name}[0]; - addPageContent(""); - if (exists $item->{data} && exists $item->{data}[0]) { - if (ref($item->{data}[0]) eq 'HASH') { - if (exists $item->{data}[0]->{desc} && exists $item->{data}[0]->{desc}[0]) { - addPageContent(""); - } - if (ref($item->{data}[0]) eq 'HASH' && exists $item->{data}[0]->{contents}[0]) { - addPageContent(""); - } - } - else { - addPageContent(""); - } - } - elsif (exists $item->{error}) { - addPageContent(""); - } - addPageContent(""); - } - addPageContent("
$item->{name}[0]$item->{data}[0]->{desc}[0]$item->{data}[0]->{contents}[0]$item->{data}[0]$item->{error}[0]
"); - } - if ($element->{data}) { - addPageContent(""); - foreach $item (@{$element->{data}}) { - my @values = split(/:/, $item, 2); - addPageContent(""); - foreach (@values) { - if ($formatType =~ /splitCommas/) { - my @fields = split(/,/, $_, -1); - foreach (@fields) { - addPageContent(""); - } - } - else { - addPageContent(""); - } - } - addPageContent("\n"); - } - addPageContent("
$_$_
"); - } - if ($element->{info}) { - addPageContent(""); - foreach $item (@{$element->{info}}) { - addPageContent(""); - my $fieldname = ''; - my $fieldvalue = ''; - - #strip whitespace in the string - $item =~ s/^\s+//; - $item =~ s/\s+$//; - if ($item =~ /Object/) { - ($fieldname, $fieldvalue) = split(/:/, $item); - } - elsif ($item =~ /.*=.*/) { - my $position = index $item, '='; - $fieldname = substr $item, 0, $position; - $fieldvalue = substr $item, $position + 1; - } - else { - $fieldname = $item; - } - addPageContent(""); - if ($fieldvalue ne '') { - addPageContent(""); - } - addPageContent("\n"); - } - addPageContent("
" . $fieldname . "" . $fieldvalue . "
"); - } - if ($element->{error}) { - addPageContent(""); - foreach $item (@{$element->{error}}) { - addPageContent(""); - } - addPageContent("
" . $item . "
"); - } +# send the response to client side, then exit +# with http there is only one return for each request, so all content should be in pageContent global variable when you call this +# create the response header by status code and format +sub sendResponseMsg { + my $code = shift; + my $tempFormat = ''; + if ('json' eq $format) { + $tempFormat = 'application/json'; } + elsif ('xml' eq $format) { + $tempFormat = 'text/xml'; + } + else { + $tempFormat = 'text/html'; + } + print $q->header(-status => $code, -type => $tempFormat); + if ($pageContent) { $pageContent .= "\n"; } # if there is any content, append a newline + print $pageContent; + exit(0); } -sub wrapXml { - my @data = shift; - foreach (@data) { - foreach (@$_) { - addPageContent(XML::Simple::XMLout($_, RootName => '', NoAttr => 1, KeyAttr => [])); - } - } +# Convert xcat request to xml for sending to xcatd +sub genRequest { + my $xml = XML::Simple::XMLout($request, RootName => 'xcatrequest', NoAttr => 1, KeyAttr => []); } # Send the request to xcatd and read the response. The request passed in has already been converted to xml. # The response returned to the caller of this function has already been converted from xml to perl structure. sub sendRequest { my $request = shift; + my $xmlinoptions = shift; # optional arg to not set ForceArray on the XMLin() call my $sitetab; my $retries = 0; @@ -2045,6 +2542,7 @@ sub sendRequest { } } + debug("request xml=$request"); print $client $request; my $response; @@ -2060,9 +2558,13 @@ sub sendRequest { #addPageContent("DEBUG: response from xcatd: " . $response . "\n"); } $response =~ s/\e/xxxxESCxxxx/g; + debug("response xml=$response"); - #print "responseXML is ".$response; - $rsp = XML::Simple::XMLin($response, SuppressEmpty => undef, ForceArray => 1); + #bmp: i added the $xmlinoptions var because for the table output it saved me processing if everything + # wasn't forced into arrays. Consider if that could save you processing on other api calls too. + if (!$xmlinoptions) { $xmlinoptions = {SuppressEmpty => undef, ForceArray => 1}; } + $rsp = XML::Simple::XMLin($response, %$xmlinoptions); + #debug(Dumper($rsp)); #add ESC back foreach my $key (keys %$rsp) { @@ -2079,7 +2581,7 @@ sub sendRequest { $response = ''; push(@$fullResponse, $rsp); - if ($rsp->{serverdone}) { + if (exists($rsp->{serverdone})) { $cleanexit = 1; last; } @@ -2095,102 +2597,40 @@ sub sendRequest { return $fullResponse; } -# Load the JSON perl module, if not already loaded. Sets the $JSON global var. -sub loadJSON { - if ($JSON) { return; } # already loaded - # require JSON dynamically and let them know if it is not installed - my $jsoninstalled = eval { require JSON; }; - unless ($jsoninstalled) { - error("JSON perl module missing. Install perl-JSON before using the xCAT REST web services API.", $STATUS_SERVICE_UNAVAILABLE); - } - $JSON = JSON->new(); -} - - -# push flags (options) onto the xcatd request. Arguments: request args array, flags array. -# Format of flags array: -sub pushFlags { - my ($args, $flags) = @_; - foreach my $f (@$flags) { - my ($key, $flag, $arg) = @$f; - if (defined($paramhash->{$key})) { - push @$args, $flag; - if ($arg) { push @$args, $paramhash->{$key}; } - } - } -} - - -# if debugging, output the given string -sub debug { - if (!$DEBUGGING) { return; } - addPageContent($q->p("DEBUG: $_[0]\n")); -} - -# when having bugs that cause this cgi to not produce any output, output something and then exit. -sub debugandexit { - addPageContent("$_[0]\n"); - sendResponseMsg($STATUS_OK); -} - -# add a error msg to the output in the correct format and end this request -#todo: replace all addPageContent/sendResponseMsg pairs to call this function instead -sub error { - my ($msg, $errorcode) = @_; - my $severity = 'error'; - my $m; - if ($format eq 'xml') { $m = "<$severity>$msg\n"; } - elsif ($format eq 'json') { $m = qq({"$severity":"$msg"}\n); } - else { $m = "

$severity: $msg

\n"; } - addPageContent($m); - sendResponseMsg($errorcode); -} - -# Append content to the global var holding the output to go back to the rest client -sub addPageContent { - my $newcontent = shift; - $pageContent .= $newcontent; -} - -# send the response to client side, then exit -# with http there is only one return for each request, so all content should be in pageContent global variable when you call this -# create the response header by status code and format -sub sendResponseMsg { - my $code = shift; - my $tempFormat = ''; - if ('json' eq $format) { $tempFormat = 'application/json'; } - elsif ('xml' eq $format) { $tempFormat = 'text/xml'; } - else { $tempFormat = 'text/html'; } - print $q->header(-status => $code, -type => $tempFormat); - print $pageContent; - exit(0); -} - -sub unsupportedRequestType { - addPageContent("request method '$requestType' is not supported on resource '$resource'"); - sendResponseMsg($STATUS_NOT_ALLOWED); -} - -# Convert xcat request to xml for sending to xcatd -sub genRequest { - if ($DEBUGGING) { - #addPageContent($q->p("DEBUG: request to xcatd: " . Dumper($request) . "\n")); - } - my $xml = XML::Simple::XMLout($request, RootName => 'xcatrequest', NoAttr => 1, KeyAttr => []); -} - # Put input parameters from both $q->url_param and put/post data (if it exists) into generalparams and paramhash for all to use +# 1st output param - The params which are listed in @generalparamlis as a general parameters like 'debug=1, pretty=1' +# 2nd output param - All the params from url params and 'PUTDATA'/'POSTDATA' except the ones in @generalparamlis sub fetchParameters { - my @generalparamlist = qw(userName password format pretty debug); + my @generalparamlist = qw(userName password pretty debug xcoll); # 1st check for put/post data and put that in the hash my $pdata; - if (isPut()) { $pdata = $q->param('PUTDATA'); } + if (isPut()) { + $pdata = $q->param('PUTDATA'); + # in the sles 11.x, the 'PUTDATA' param is not supported for PUT method + # so we have to work around it by getting it by myself + unless ($pdata) { + if (-f "/etc/SuSE-release") {# SUSE os + if ($ENV{'CONTENT_TYPE'} =~ /json/) { + $q->read_from_client(\$pdata, $ENV{'CONTENT_LENGTH'}); + } + } + } + } elsif (isPost()) { $pdata = $q->param('POSTDATA'); } + if ($dbgdata) { + $pdata = $dbgdata; + } my $genparms = {}; my $phash; if ($pdata) { $phash = eval { $JSON->decode($pdata); }; - if ($@) { error("$@",$STATUS_BAD_REQUEST); } + if ($@) { + # remove the code location information to make the output looks better + if ($@ =~ m/ at \//) { + $@ =~ s/ at \/.*$//; + } + error("$@",$STATUS_BAD_REQUEST); + } #debug("phash=" . Dumper($phash)); if (ref($phash) ne 'HASH') { error("put or post data must be a json object (hash/dict).", $STATUS_BAD_REQUEST); } @@ -2217,29 +2657,85 @@ sub fetchParameters { return ($genparms, $phash); } -# Functions to test the http request type -sub isGet { return uc($requestType) eq "GET"; } - -sub isPut { return uc($requestType) eq "PUT"; } - -sub isPost { return uc($requestType) eq "POST"; } - -sub isPatch { return uc($requestType) eq "PATCH"; } - -sub isDelete { return uc($requestType) eq "DELETE"; } - -# check to see if this is a valid user. userName and password are already set -# this function is not currently used. -sub isAuthenticUser { - $request->{command} = 'authcheck'; - my $req = genRequest(); - my $responses = sendRequest($req); - if ($responses->[0]->{data}[0] eq "Authenticated") { - - #user is authenticated - return 1; +# Load the XML::Simple module +sub loadXML { + if ($xmlinstalled) { return; } + + $xmlinstalled = eval { require XML::Simple; }; + unless ($xmlinstalled) { + error('The XML::Simple perl module is missing. Install perl-XML-Simple before using the xCAT REST web services API with this format."}',$STATUS_SERVICE_UNAVAILABLE); } - - #authentication failure - error($responses->[0]->{error}[0], $STATUS_UNAUTH); + $XML::Simple::PREFERRED_PARSER = 'XML::Parser'; } + +# Load the JSON perl module, if not already loaded. Sets the $JSON global var. +sub loadJSON { + if ($JSON) { return; } # already loaded + # require JSON dynamically and let them know if it is not installed + my $jsoninstalled = eval { require JSON; }; + unless ($jsoninstalled) { + error("JSON perl module missing. Install perl-JSON before using the xCAT REST web services API.", $STATUS_SERVICE_UNAVAILABLE); + } + $JSON = JSON->new(); +} + +# add a error msg to the output in the correct format and end this request +sub error { + my ($errmsg, $httpcode, $errorcode) = @_; + my $json; + $json->{error} = $errmsg; + $json->{errorcode} = '2'; + if ($errorcode) { + $json->{errorcode} = $errorcode; + } + + addPageContent($JSON->encode($json)); + sendResponseMsg($httpcode); +} + + +# if debugging, output the given string +sub debug { + if (!$DEBUGGING) { return; } + addPageContent($q->p("DEBUG: $_[0]\n")); +} + +# when having bugs that cause this cgi to not produce any output, output something and then exit. +sub debugandexit { + debug("$_[0]\n"); + sendResponseMsg($STATUS_OK); +} + +sub displaydebugmsg { + addPageContent($q->p("DEBUG: generalparams:". Dumper($generalparams))); + addPageContent($q->p("DEBUG: paramhash:". Dumper($paramhash))); + addPageContent($q->p("DEBUG: q->request_method: $requestType\n")); + #addPageContent($q->p("DEBUG: q->user_agent: $userAgent\n")); + addPageContent($q->p("DEBUG: pathInfo: $pathInfo\n")); + #addPageContent($q->p("DEBUG: path " . Dumper(@path) . "\n")); + #foreach (keys(%ENV)) { addPageContent($q->p("DEBUG: ENV{$_}: $ENV{$_}\n")); } + #addPageContent($q->p("DEBUG: userName=".$paramhash->{userName}.", password=".$paramhash->{password}."\n")); + #addPageContent($q->p("DEBUG: http() values:\n" . http() . "\n")); + #if ($pdata) { addPageContent($q->p("DEBUG: pdata: $pdata\n")); } + addPageContent("\n"); + if ($DEBUGGING == 3) { + sendResponseMsg($STATUS_OK); # this will also exit + } +} + + +# push flags (options) onto the xcatd request. Arguments: request args array, flags array. +# Format of flags array: +# Use this function for cmds with a lot of flags like xdcp and xdsh +sub pushFlags { + my ($args, $flags) = @_; + foreach my $f (@$flags) { + my ($key, $flag, $arg) = @$f; + if (defined($paramhash->{$key})) { + push @$args, $flag; + if ($arg) { push @$args, $paramhash->{$key}; } + } + } +} + +