mmrest command

Manages the Scale Management server.

Synopsis

mmrest setup base --ssl-cert-file ServerCertFile --ssl-key-file ServerKeyFile
[--server-user user] [--server-group Group]

mmrest setup base --remove-config

mmrest setup auth --keystone [--uri URI] [--project Project] [--user User]
[--pwd-file PasswordFile] [--cafile CAFile]

mmrest setup auth --ssgui [--url URL] [--cafile CAFile]

mmrest setup auth --none

mmrest setup node --cleanup

mmrest change base [--ssl-cert-file ServerCertFile] [ssl-key-file ServerKeyFile]

mmrest list base

mmrest list auth

Availability

Available on all IBM Spectrum Scale™ editions.

Note: The mmrest command is installed when you install the Scale Management server. See the topic Installing the Scale Management server (REST API).

Description

Use the mmrest command to manage the Scale Management server. The REST API daemon runs on this server.

Important: To activate the changes that you make with the mmrest command, you must restart the Scale Management server on each node where it is installed. To restart the server, enter the following command:

systemctl restart httpd

The configuration changes that you make with the mmrest command are stored in a master copy in the CCR repository. When you restart the server on a node, the server downloads the latest configuration changes from the master copy in the CCR.

Parameters

setup

Sets up the Scale Management server configuration.

base

Stores or removes the base configuration. Base configuration consists of security information and other values. The command stores the configuration information in the CCR repository of the cluster. All Scale Management nodes in the cluster use this information.

--ssl-cert-file CertFile: SSL certificates that the HTTPS server uses.
--ssl-key-file KeyFile: Security keys that the HTTPS server uses.
--server-user User: The user that the server runs as. The default value is scalemgmt.
--server-group Group: The group that the server runs as. The default value is scalemgmt.
--remove-config: Removes the configuration information from the CCR repository of the cluster.

auth

Sets up or modifies client authentication for the Scale Management server.

--keystone

Authenticates clients using OpenStack Identity (Keystone).

--uri URI: The full, unversioned URI to the Keystone endpoint, which includes the protocol (HTTP or HTTPS), the server name, and the port number, such as https://KeystoneServer:35357. The Scale Management server uses this information to access the Keystone server.
--project Project: The Keystone project that the user is a member of. The default value is admin.
--user User: The user account that the server specifies when connects to Keystone.
--pwd-file PasswordFile: A text file that contains the password of the Keystone user on the first line. If the first line consists of only a hyphen (-), then the command prompts you for a password through stdin.
--cafile CAFile: The certificate authority file that the server uses to validate information from Keystone.

--ssgui

Authenticates clients using the IBM Spectrum Scale GUI.

--url URL: The URL of the server, including the port number, such as https://guiserver:443/auth.
--cafile CAFile: The certificate authority file that the Scale Management server uses to validate information from the GUI server.

--none

Disables client authentication.

Warning: Use this setting only if you have appropriate safeguards to avoid security risks.

node

Configures a node to be a Scale Management server.

--cleanup: Removes the local copy of the configuration files from the current node. The master copy of the configuration files in the CCR remains unchanged.

change

Changes the Scale Management server configuration.

base

Changes the base configuration.

--ssl-cert-file CertFile: Changes the certificate file that the server uses.
--ssl-key-file KeyFile: Change the SSL keys that the server uses.

list

Lists the server configuration.

base: Lists the base configuration.
auth: Lists the authentication setup.

Exit status

0: Successful completion.
nonzero: A failure occurred.

Security

You must have root authority to run the mmrest command.

The node on which the command is issued must be able to execute remote shell commands on any other node in the cluster without the use of a password and without producing any extraneous messages. For more information, see Requirements for administering a GPFS file system.

Examples

The following command sets up the base configuration information of the server:

mmrest setup base \
--ssl-cert-file "/etc/pki/tls/certs/localhost.crt" \
--ssl-key-file "/etc/pki/tls/private/localhost.key"

The following command sets up client authentication with a Keystone server:

mmrest setup auth --keystone --uri http://ksserver.example.com:35357 \
  --project service --user admin --pwd-file ./kspw.txt \
  --cafile /etc/keystone/ssl/certs/ssl_cacert.pem

Remember: To activate the changes that you make with the mmrest command, you must restart the Scale Management server on each node where it is installed. To restart the server, enter the following command:

systemctl restart httpd

See the Description section of this topic.

Location

/usr/lpp/mmfs/bin