This section contains information on how to configure the following SAs with CLI.
Blade
IPMI
ICMP
VMCHKHOST
libvirt
VMware vCenter Server functional cooperation
FUJITSU Hybrid IT Service FJcloud-O/FJcloud-Baremetal API
OpenStack API
AWS CLI
Azure CLI
NIFCLOUD API
Blade
To configure the Blade shutdown agent (SA_blade), you can create or modify the following file:
/etc/opt/SMAW/SMAWsf/SA_blade.cfg
The template of SA_blade.cfg file can be found at the following location:
/etc/opt/SMAW/SMAWsf/SA_blade.cfg.template
The format of SA_blade.cfg file is as follows:
community-string SNMP community string management-blade-ip IP address cfname slot-no Action
Additionally, you can add the IP address of the management Blade for a second Blade chassis. In this case, you would need to add one or more lines to specify the Blades in that chassis.
Note
management-blade-ip, community-string, cycle, and leave-off are reserved words. They must be described in lowercase letters.
The editable fields are defined as follows:
SNMP community string
The SNMP community string with read/write permissions for the server Blades. This string is the same value as the SNMP community string in the Management Blade SNMP configuration. By default, this string is usually set to public.
IP-address
The IP name or address in dot notation of the Management Blade. Available IP addresses are IPv4 and IPv6 address. The link local address of IPv6 is not available.
cfname
The name of the node in the CF cluster.
slot-no
The slot number of the Blade server.
Action
The action can either be cycle or leave-off. If it is cycle, the node will be powered on again after powering off. If it is leave-off, manual action is required to turn the system back on.
The following is an example of SA_blade.cfg file:
community-string public management-blade-ip 123.45.56.78 shasta1 1 cycle shasta2 3 leave-off management-blade-ip 123.45.56.79 shasta3 1 cycle shasta4 2 cycle
The log file is stored in the following:
/var/opt/SMAWsf/log/SA_blade.log
IPMI
To configure the IPMI shutdown agent (SA_ipmi), you need to create or modify the following file:
/etc/opt/SMAW/SMAWsf/SA_ipmi.cfg
The template of SA_ipmi.cfg file can be found at the following location:
/etc/opt/SMAW/SMAWsf/SA_ipmi.cfg.template
SA_ipmi.cfg file contains lines with four fields (and some subfields) on each line. Each line defines a node in the cluster that can be powered off (leaving it off) or powered off and then on again (power cycle). The fields are as follows:
cfname
The name of the node in the CF cluster.
Note
cfname must correspond to the IP address of the IPMI compliant onboard LAN interface in these nodes.
Access-Information
The access information is of the following format:
ip-address-of-unit:user:password
For ip-address-of-unit, specify the IP address of iRMC or BMC. Available IP addresses are IPv4 and IPv6 address. The link local address of IPv6 is not available. When specifying the IPv6 address, enclose it in brackets "[ ]".
(Example: [1080:2090:30a0:40b0:50c0:60d0:70e0:80f0])
Action
The action can either be cycle or leave-off. If it is cycle, the node will be powered on again after powering off. If it is leave-off, manual action is required to turn the system back on.
Note
The permissions of the SA_ipmi.cfg file are read/write by root only. This is to protect the password to the iRMC/BMC unit.
The following is an example of SA_ipmi.cfg file:
shasta1 192.168.200.1::root:ipmipwd cycle shasta2 192.168.200.2::root:ipmipwd cycle shasta3 192.168.200.3::root:ipmipwd leave-off shasta4 192.168.200.4::root:ipmipwd leave-off
The log file is stored in the following:
/var/opt/SMAWsf/log/SA_ipmi.log
ICMP
To configure the ICMP shutdown agent (SA_icmp), you need to create or modify the following file:
/etc/opt/SMAW/SMAWsf/SA_icmp.cfg
The template of SA_icmp.cfg file can be found at the following location:
/etc/opt/SMAW/SMAWsf/SA_icmp.cfg.template
The format of SA_icmp.cfg file is as follows:
TIME_OUT=value cfname:ip-address-of-node:NIC-name1,NIC-name2
The editable fields are defined as follows:
value
Specify the time in seconds to check for the existence of a node. The recommended value is 5 seconds.
cfname
Specify a CF node name.
ip-address-of-node
Specify any of the following IP addresses of cfname. Available IP addresses are IPv4 and IPv6 address. The link local address of IPv6 is not available. When specifying the IPv6 address, enclose it in brackets "[ ]".
(Example: [1080:2090:30a0:40b0:50c0:60d0:70e0:80f0] )
Administrative LAN
Public LAN
Cluster interconnect
You must describe one or more IP addresses for all the nodes in the cluster. Add a new line to specify more than one LAN routes. It is recommended that you specify more than one routes to check the LAN routes.
NIC-nameX
For ip-address-of-node, specify a network interface used to check the existence of the node. If there are more than one network interfaces, separate them with a comma.
Note
Note the following when you describe network interfaces:
When duplicating the network by GLS, you need to describe all redundant network interfaces. (For example, eth0,eth1)
When bonding NICs, you need to describe a bonding device after the IP address. (For example, bond0)
When describing cluster interconnects, you need to describe all network interfaces used in all paths of the cluster interconnects. (For example, eth2,eth3)
The following is an example of SA_icmp.cfg file:
TIME_OUT=5 shasta1:10.20.30.100:eth0,eth1 shasta1:10.20.40.200:eth2 shasta2:10.20.30.101:eth0,eth1 shasta2:10.20.40.201:eth2
The log file is stored in the following:
/opt/SMAW/SMAsf/log/SA_icmp.log
VMCHKHOST
To configure the Shutdown Agent (SA_vmchkhost) to switch the HOST OS in the event of an error in the virtual machine environment, you must create or modify the following file:
/etc/opt/SMAW/SMAWsf/SA_vmchkhost.cfg
The template of SA_vmchkhost.cfg file is stored in the following:
/etc/opt/SMAW/SMAWsf/SA_vmchkhost.cfg.template
Each line of SA_vmchkhost.cfg file includes the following five fields:
guest-cfname
CF node name of a guest OS.
host-cfname
CF node name of the Host OS.
ip-address
IP address of the Host OS. Available IP addresses are IPv4 and IPv6 address. The link local address of IPv6 is not available.
user
Account of the Host OS.
For a KVM environment, specify the user name that was created when setting libvirt to the Shutdown Facility.
password
Login password for the account that was specified with "user."
The encrypted password for the user with general privileges for the Shutdown Facility, which was used when setting libvirt to the Shutdown Facility, is used.
The following is an example of SA_vmchkhost.cfg file:
shasta1 hostos2 192.168.200.1 FJSVvmSP 3CA1wxVXKD8a93077BaEkA== shasta2 hostos3 192.168.200.2 FJSVvmSP 3CA1wxVXKD8a93077BaEkA==
The log file is stored in the following:
/var/opt/SMAWsf/log/SA_vmchkhost.log
libvirt
To configure the Shutdown Agent (SA_libvirtgp) for PANIC or Shutdown Agent (SA_libvirtgr) for RESET of libvirt, you must create or modify the following files respectively.
/etc/opt/SMAW/SMAWsf/SA_libvirtgp.cfg /etc/opt/SMAW/SMAWsf/SA_libvirtgr.cfg
The templates of SA_libvirtgp.cfg file and SA_libvirtgr.cfg file are stored in the following:
/etc/opt/SMAW/SMAWsf/SA_libvirtgp.cfg.template /etc/opt/SMAW/SMAWsf/SA_libvirtgr.cfg.template
Each line of SA_libvirtgp.cfg file and SA_libvirtgr.cfg file includes the following five fields:
cfname
Node name on the CF cluster.
domain
Domain name of a guest OS.
ip-address
IP address of the hypervisor. Available IP addresses are IPv4 and IPv6 address. The link local address of IPv6 is not available.
user
Account of the hypervisor. The user for shutdown facility is specified.
password
Login password for the account specified in "user" field. Describe the password encrypted by the encryption command, sfcipher(8). For details on the sfcipher(8) command, see the manual pages of "sfcipher(8)."
The following is an example of SA_libvirtgp.cfg file:
shasta1 domain2 192.168.200.1 user 3CA1wxVXKD8a93077BaEkA== shasta2 domain3 192.168.200.2 user 3CA1wxVXKD8a93077BaEkA==
The following is an example of SA_libvirtgr.cfg file:
shasta1 domain2 192.168.200.1 user 3CA1wxVXKD8a93077BaEkA== shasta2 domain3 192.168.200.2 user 3CA1wxVXKD8a93077BaEkA==
The log file is stored in the following:
/var/opt/SMAWsf/log/SA_libvirtgp.log /var/opt/SMAWsf/log/SA_libvirtgr.log
VMware vCenter Server functional cooperation
To configure the VMware vCenter Server functional cooperation shutdown agent (SA_vwvmr), you need to create or modify the following file:
/etc/opt/SMAW/SMAWsf/SA_vwvmr.cfg
The template of SA_vwvmr.cfg file can be found at the following location:
/etc/opt/SMAW/SMAWsf/SA_vwvmr.cfg.template
The format of SA_vwvmr.cfg file is as follows:
CFName: cfname VMName: vmname vCenter_IP: IP address vCenter_Port: port user: user passwd: passwd
The editable fields are defined as follows:
cfname
The name of the node in the CF cluster.
vmname
VM name of the guest OS. Use the character code UTF-8 if the name is described in Japanese.Use the character code UTF-8 if the name is described in Japanese.
IP address
The IP address of VMware vCenter Server. Available IP addresses are IPv4 and IPv6 address. The link local address of IPv6 is not available.
port
Specify the port number of VMware vCenter Server.
When using the default value (443), describe it as "vCenter_Port:".
user
The user to log in VMware vCenter Server. Specify the user for the shutdown agent.
password
Login password for the user specified in "user" field. Describe the password encrypted by the encryption command, sfcipher(8). For details on the sfcipher(8) command, see the manual pages of "sfcipher(8)."
The following is an example of SA_vwvmr.cfg file:
Example: Port number of VMware vCenter Server is the default value (443)
CFName: shasta1 VMName: shasta1vm vCenter_IP: 192.168.100.1 vCenter_Port: user: PCL passwd: 3CA1wxVXKD8a93077BaEkA==
Example: Port number of VMware vCenter Server is10443
CFName: shasta1 VMName: shasta1vm vCenter_IP: 192.168.100.1 vCenter_Port: 10443 user: PCL passwd: 3CA1wxVXKD8a93077BaEkA==
The log file is stored in the following:
/var/opt/SMAWsf/log/SA_vwvmr.log
FUJITSU Hybrid IT Service FJcloud-O/FJcloud-Baremetal API
To configure the FUJITSU Hybrid IT Service FJcloud-O/FJcloud-Baremetal API shutdown agent (SA_vmk5r), you must create or modify the following files:
/opt/SMAW/SMAWRrms/etc/k5_endpoint.cfg /etc/opt/SMAW/SMAWsf/SA_vmk5r.cfg
/opt/SMAW/SMAWRrms/etc/k5_endpoint.cfg
The format of k5_endpoint.cfg file is as follows:
DOMAIN_NAME=domainname PROJECT_NAME=projectname IDENTITY=identityurl COMPUTE=computeurl
The editable fields are defined as follows:
domainname
Domain name (contractor number) of an FJcloud-O/FJcloud-Baremetal environment.
projectname
Project name that configures the cluster in an FJcloud-O/FJcloud-Baremetal environment.
identityurl
Endpoint URL of the regional user management of a region used in an FJcloud-O/FJcloud-Baremetal environment.
computeurl
Endpoint URL of the compute (standard service) of a region used in an FJcloud-O/FJcloud-Baremetal environment.
The following is an example of the k5_endpoint.cfg file:
DOMAIN_NAME=primecluster_domain PROJECT_NAME=primecluster_project IDENTITY=https://identity.jp-east-3.cloud.global.fujitsu.com COMPUTE=https://compute.jp-east-3.cloud.global.fujitsu.com
/etc/opt/SMAW/SMAWsf/SA_vmk5r.cfg
The template of SA_vmk5r.cfg file is in the following location:
/etc/opt/SMAW/SMAWsf/SA_vmk5r.cfg.template
The format of SA_vmk5r.cfg file is as follows:
cfname machinename user passwd Action
Each line of SA_vmk5r.cfg file includes five fields. Each line defines a node in the cluster that can be powered off (leaving it off) or powered off and then on again (power cycle). The fields are as follows:
cfname
The name of the node in the CF cluster.
machinename
The virtual machine name on which the cluster host is working.
user
User name to control the virtual machine.
password
Login password for the user specified in "user" field. Describe the password encrypted by the encryption command, sfcipher(8). For details on the sfcipher(8) command, see the manual pages of "sfcipher(8)."
Action
The action can either be cycle or leave-off. If it is cycle, the node will be powered on again after powering off. If it is leave-off, manual action is required to turn the system back on.
The following is an example of SA_vmk5r.cfg file:
node1 vm1 pcl O/gm+AYuWwE7ow3dgVG/Nw== cycle node2 vm2 pcl O/gm+AYuWwE7ow3dgVG/Nw== cycle
The log file is stored in the following:
/var/opt/SMAWsf/log/SA_vmk5r.log
OpenStack API
To configure the OpenStack API shutdown agent (SA_vmosr), you must create or modify the following files:
/opt/SMAW/SMAWRrms/etc/os_endpoint.cfg /etc/opt/SMAW/SMAWsf/SA_vmosr.cfg
/opt/SMAW/SMAWRrms/etc/os_endpoint.cfg
The format of os_endpoint.cfg file is as follows:
DOMAIN_NAME=domainname PROJECT_NAME=projectname IDENTITY=identityurl COMPUTE=computeurl
The editable fields are defined as follows:
domainname
Domain name of an RHOSP environment.
projectname
Project name that configures the cluster in an RHOSP environment.
identityurl
Endpoint URL of the Identity service used in an RHOSP environment.
Note: Do not include any character strings from "/vX.X" in URL.
computeurl
Endpoint URL of the Compute service used in an RHOSP environment.
Note: Do not include any character strings from "/vX.X" in URL.
The following is an example of the os_endpoint.cfg file:
DOMAIN_NAME=primecluster_domain PROJECT_NAME=primecluster_project IDENTITY=https://192.168.11.11:5000 COMPUTE=https://192.168.11.11:8774
/etc/opt/SMAW/SMAWsf/SA_vmosr.cfg
The template of SA_vmosr.cfg file is in the following location:
/etc/opt/SMAW/SMAWsf/SA_vmosr.cfg.template
The format of SA_vmosr.cfg file is as follows:
cfname instancename user passwd
The editable fields are defined as follows:
cfname
The name of the node in the CF cluster.
instancename
The instance name on which the cluster host is working.
user
User name to control the instance.
password
Login password for the user specified in "user" field. Describe the password encrypted by the encryption command, sfcipher(8). For details on the sfcipher(8) command, see the manual pages of "sfcipher(8)."
The following is an example of SA_vmosr.cfg file:
node1 instance1 pcl O/gm+AYuWwE7ow3dgVG/Nw== node2 instance2 pcl O/gm+AYuWwE7ow3dgVG/Nw==
The log file is stored in the following:
/var/opt/SMAWsf/log/SA_vmosr.log
AWS CLI
To configure the AWS CLI shutdown agent (SA_vmawsAsyncReset), you must create or modify the following file:
/etc/opt/SMAW/SMAWsf/SA_vmawsAsyncReset.cfg
The template of the SA_vmawsAsyncReset.cfg file is in the following location:
/etc/opt/SMAW/SMAWsf/SA_vmawsAsyncReset.cfg.template
The format of the SA_vmawsAsyncReset.cfg file is as follows:
cfname InstanceID [ProfileName]
Each line of the SA_vmawsAsyncReset.cfg file includes three fields. Each line defines a node in the cluster. The fields are as follows:
cfname
The CF node name of the cluster host.
InstanceID
The instance ID of AWS on which the cluster host is working.
[ProfileName]
Describe the profile name of the credentials used with the AWS Command Line Interface.
When this item is omitted, the shutdown agent works with the default profile.
The following is an example of the SA_vmawsAsyncReset.cfg file:
node1 i-abcdef0123456789a userprofile1 node2 i-abcdef0123456789b userprofile1
The log file is stored in the following:
/var/opt/SMAWsf/log/SA_vmawsAsyncReset.log
Azure CLI
To configure the Azure CLI shutdown agent (SA_vmazureReset), you must create or modify the following file:
/etc/opt/SMAW/SMAWsf/SA_vmazureReset.cfg
The template of the SA_vmazureReset.cfg file is in the following location:
/etc/opt/SMAW/SMAWsf/SA_vmazureReset.cfg.template
The format of the SA_vmazureReset.cfg file is as follows:
cfname ResourceID AppID TenantID CertPath {cycle | leave-off}
Each line of the SA_vmazureReset.cfg file includes six fields. Each line defines a node in the cluster. The fields are as follows:
cfname
The CF node name of the cluster host.
ResourceID
The resource ID of the Azure virtual machine on which the cluster host is working.
AppID
Specify the application ID when registering the service principal.
TenantID
Specify the tenant ID when registering the service principal.
CertPath
Specify the path of the certificate.
{cycle | leave-off}
Describe the operation after forcibly stopping the node.
cycle: Restart the node after forcibly stopping the node.
leave-off: The node is not restarted after it is forcibly stopped.
The following is an example of the SA_vmazureReset.cfg file:
node1 /subscriptions/1e234d12-39b8-49db-881a-35aa03b402b9/resourceGroups/pcl-mw1/providers/Microsoft.Compute/virtualMachines/node1 d5b7dac1-718f-448b-8e11-4a8cca6d9004 8ff7ddfd-fbcb-4700-ae52-6d071ac8d1b4 /root/examplecert.pem cycle node2 /subscriptions/1e234d12-39b8-49db-881a-35aa03b402b9/resourceGroups/pcl-mw1/providers/Microsoft.Compute/virtualMachines/node2 d5b7dac1-718f-448b-8e11-4a8cca6d9004 8ff7ddfd-fbcb-4700-ae52-6d071ac8d1b4 /root/examplecert.pem cycle
The log file is stored in the following:
/var/opt/SMAWsf/log/SA_vmazureReset.log
NIFCLOUD API
To configure the NIFCLOUD API shutdown agent (SA_vmnifclAsyncReset), you must create or modify the following file:
/etc/opt/SMAW/SMAWsf/SA_vmnifclAsyncReset.cfg
The template of the SA_vmnifclAsyncReset.cfg file is in the following location:
/etc/opt/SMAW/SMAWsf/SA_vmnifclAsyncReset.cfg.template
The format of the SA_vmnifclAsyncReset.cfg file is as follows:
CFNameX ServerName Region Accesskey SecretAccesskey
Each line of the SA_vmnifclAsyncReset.cfg file includes five fields. Each line defines a node in the cluster. The fields are as follows:
CFNameX
The CF node name of the cluster host.
ServerName
The server name of NIFCLOUD on which the cluster host is working.
Region
The region of the endpoint used in a NIFCLOUD environment.
Specify the "jp-east-X" format for the East Japan region and the "jp-west-X" format for the West Japan region.
Accesskey
The AccessKey used for authenticating the NIFCLOUD API.
SecretAccesskey
The SecretAccessKey used for authenticating the NIFCLOUD API. Describe the SecretAccessKey encrypted by the encryption command, sfcipher(8).
For details on the sfcipher(8) command, see the manual pages of "sfcipher(8)."
The following is an example of the SA_vmnifclAsyncReset.cfg file:
# cat /etc/opt/SMAW/SMAWsf/SA_vmnifclAsyncReset.cfg
node1 pclserver1 jp-east-1 123456789ABCDEFGHIJK PIJgi9wm4sYJlfWShOxWP6fpz0Xb6t9KmRc4sPDsRBIGfm6gT5m0xH2H2xf1r38G
node2 pclserver2 jp-east-1 123456789ABCDEFGHIJK PIJgi9wm4sYJlfWShOxWP6fpz0Xb6t9KmRc4sPDsRBIGfm6gT5m0xH2H2xf1r38G
The log file is stored in the following:
/var/opt/SMAWsf/log/SA_vmnifclAsyncReset.log