service_console Commands

Command to manage the system service console and block or allow its use

Modes: Daily

The service_console command lets a site administrator manage the system service console and block or allow its use for a service technician.

The service console is an alternate system management interface that is limited to maintenance functions, and is for use by authorized service personnel only. Even though it bypasses the normal administrative login, the service console cannot be used to access the root account, or to access data on the Lustre file system.

While it is not necessary to disable the service console for any system that is physically secure, administrators in high-security environments might prefer to disable it. In that case, they will need to re-enable the service console every time a service technician arrives on site to perform system maintenance, including replacement of failed disk drives and other parts.

Configuration consists of two main areas:

Configuring the SMTP relay, which allows the system to send emails to users and service emails
Configuring user email addresses to allow service email to go to system users

This following commands and available subcommands are used to manage the service console:

Synopsis

$ cscli service_console [-h] {enable,disable,show,notifications,configure}

where

Subcommands	Description
`enable`	Enables the service console
`disable`	Disables the service console
`show`	Show service console enabled status
`notifications`	View RAS notifications
`configure`	Configure RAS notifications

Optional Arguments	Description
`-h \|--help`	Displays the help message and exits

Examples

Enable the service console.

$ cscli service_console enable 
Service Console enabled.

Disable the Service console.

$ cscli service_console disable 
Service Console disabled.

Show the status of the service console (enabled).

$ cscli service_console show 
Service console enabled.

Show service console notifications (service events).

$ cscli service_console notifications show 
Current outstanding service call events: 

Item 1 : "Disk drive needs replacement"

Service Code: 002005001 
Time the event was first detected: Wed, 17 Jun 2015 17:18:14 EDT 

    Details of failed component    
    Disk Serial #: S0M122HN0000B40298QD 
    Disk Model: ST600MM0006 Drive 
    Manufacturer: SEAGATE 
    Firmware version of drive at time of failure: XLGE T10     Enabled: Yes 

Location of failed component 

    Rack Name: Rack1 
    Enclosure Model: 2U24 
    Enclosure Location: 36U 
    Disk located in slot: 15

Item 2: "Power supply issue detected"

Service Code: 002005003
Time the event was first detected: Wed, 02 Dec 2015 12:58:57 PST

Details of failed component

    Power supply chassis type: OneStor Power One 764W_AC_PCM (Original Silver DFM).
    Power supply part number: 0945768-10
    Power supply product version: 0314
    Power supply serial number: PMW0945768J1BDY

Location of failed component
        
    Rack Name: R1C1
    Enclosure Model: 2U24
    Enclosure Location: 24U
    Power supply located in bay: 1

Show service console configuration options.

$ cscli service_console configure
Commands:
    smtp             Configure SMTP settings
    snmp             Configure SNMP settings
    email            Configure email for sending RAS notifications    
    system           Configure system settings
    rest_api         Configure REST API settings

`notifications` Subcommand

The notifications command is a subcommand of the service_console command, and is used to view notifications.

Synopsis

$ cscli service_console notifications [-h] {show}


Subcommands	Description
`show`	Show outstanding notifications.


Optional Arguments	Description
`-h \|--help`	Displays the help message and exits.

Service Console Configuration Commands

These commands are used to configure the SMTP relay, SNMP, remote support, email addresses for RAS notifications, system and REST API settings.

Synopsis

$ cscli service_console configure {smtp,snmp,remote_support,email,system,rest_api}


Subcommands	Description
`smtp`	Configures SMTP settings
`snmp`	Configures SNMP settings
`remote_support`	Configure remote support RAS notifications
`email`	Configure email for sending RAS notifications
`system`	Configure system settings
`rest_api`	Configure REST API settings


Optional Arguments	Description
`-h \|--help`	Display the help message and exit

`smtp` Commands

The smtp command is a second-level subcommand of the service_console command, and is used to configure SMTP.

Synopsis

$ cscli service_console configure smtp [-h]

Usage

cscli service_console [options] configure [options] smtp [options]


Optional Arguments	Description
`-h \|--help`	Displays the help message and exits.

Entry point for ClusterStor Manager CLI.


Subcommands	Description
`relay`	Configure SMTP relay for sending notifications
`from`	Configure SMTP from email address for sending notifications
`show`	Display the SMTP configuration

`relay` Command

The relay command is the third-level subcommand of the service_console command, and is used to configure SMTP relay.

Synopsis

$ cscli service_console configure smtp relay [-h] -H smtp_host -P smtp_port


Subcommands	Description
`-P smtp_port \|--port smtp_port`	SMTP port [default: 25]
`-H smtp_host \|--host smtp_host`	SMTP host (required)


Optional Arguments	Description
`-h \|--help`	Displays the help message and exits.

Examples

Configure the SMTP relay.

$ cscli service_console configure smtp relay -H 
mailrelayus.xyus.xyratex.com 
OK.

Show the current SMTP configuration.

$ $ cscli service_console configure smtp show 
SMTP relay: mailrelayus.xyus.xyratex.com:25

`snmp` Command

The snmp command is a second-level subcommand of the service_console command, and is used to configure SNMP settings

Synopsis

$ cscli service_console configure snmp [-h] {enable,disable,show}


Subcommands	Description
`enable`	Enables SNMP monitoring
`disable`	Disables SNMP monitoring
`show`	Shows current SNMP settings


Optional Arguments	Description
`-h \|--help`	Displays the help message and exits

`remote_support` Commands

The remote_support command is a second-level subcommand of the service_console command, and is used to configure SMTP remote support.

Synopsis

$ cscli service_console configure remote_support [-h] {enable,disable,show}


Subcommands	Description
`enable`	Enables remote support
`disable`	Disables remote support
`show`	Shows current remote support status


Optional Arguments	Description
`-h \|--help`	Displays the help message and exits

Examples

Disable remote support.

$ cscli service_console configure remote_support disable

Remote Support disabled.

Display remote support status.

$ cscli service_console configure remote_support show
Remote Support enabled.

Enable remote support.

$ cscli service_console configure remote_support enable
Remote Support enabled.

Email Notification Commands

This command configures email notifications, including enabling or disabling notification functionality, adds or deletes email addresses to the user list, shows user list entries and sends test email to determine if user notifications can be sent successfully.

Synopsis

$ cscli service_console configure email [-h] {show,add,delete,enable,disable,send_test_email}


Subcommands	Description
`show`	Shows all notification email addresses
`add`	Adds a notification email address. Also specify the email address to be added (required): `-A email_address \|--address email_address`
`delete`	Deletes a notification email address Also specify the email address to be deleted (required): `-A email_address \|--address email_address`
`enable`	Enables email notifications
`disable`	Disables email notifications
`send_test_email`	Sends test email to all enabled services


Optional Arguments	Description
`-h \|--help`	Displays the help message and exits

Examples

Show email addresses configured to receive RAS notifications (no configured addresses).

$  cscli service_console configure email show
No email addresses are configured to receive service notifications.

Show email addresses configured to receive RAS notifications (several configured addresses).

$  $ cscli service_console configure email show 
The following email addresses are configured to receive service notifications:
sam_jones@xyzcorp.com
amy_cooper@xyzcorp.com

Add an email address to the user list (success).

$ cscli service_console configure email add –A sam_jones@xyzcorp.com
Successfully added 'sam_jones@xyzcorp.com' to receive notification emails.

Add an email address to the user list (fails because it is currently associated with the user list).

$ cscli service_console configure email add –A sam_jones@xyzcorp.com
Unable to add: 'sam_jones@xyzcorp.com' is already configured for receiving notification emails.

Delete an email address from the user list (success).

$ cscli service_console configure email delete –A sam_jones@xyzcorp.com
Successfully removed 'sam_jones@xyzcorp.com' from receiving notification emails.

Delete an email address from the user list (fails because it is not associated with the user list).

$ cscli service_console configure email delete –A sam_jones@xyzcorp.com
Unable to delete: 'sam_jones@xyzcorp.com' is not configured for receiving notification emails.

Enable email notifications.

$ cscli service_console configure email enable
OK.

Disable email notifications.

$ cscli service_console configure email disable
OK.

`system` Command

The system command is a second-level subcommand of the service_console command, and is used to configure system settings.

Synopsis

$ cscli service_console configure system [-h] {identifier,show}


Subcommands	Description
`identifier`	Sets the system identifier
`show`	Shows the current system identifier (name)


Optional Arguments	Description
`-h \|--help`	Displays the help message and exits

Examples

Show the current system identifier (name specified).

$ cscli service_console configure system show
System settings: 
    System identifier name: snx-002

Show the current system identifier (no name set).

$ cscli service_console configure system show

`identifier` Command

The identifier command is a third-level subcommand of the service_console command, and is used to set the system identifier name.

Synopsis

$ cscli service_console configure system identifier [-h] -n id_name

Usage

$ cscli service_console [options] configure [options] system [options] identifier [options]


Optional Arguments	Description
`-h \|--help`	Displays the help message and exits
`-n id_name \|--name=id_name`	Name (required)

Example

Set the system identifier.

$ cscli service_console configure system identifier –-name=snx-002
System identifier name has been set to: snx-002

`rest_api` Command

The rest_api command is a second-level subcommand of the service_console command, and is used to configure REST API settings.

Synopsis

[root@cls12345 ~]# cscli service_console configure rest_api [-h]

Usage

cscli service_console [options] configure [options] rest_api [options]


Subcommands	Description
`enable`	Enable REST API
`disable`	Disable REST API
`show`	Inform of REST API access status and list authorized users
`user_add`	Add a user to list of REST API authorized users
`user_delete`	Remove a user from the list of REST API authorized users


Optional Arguments	Description
`-h \|--help`	Displays the help message and exits

service_console Commands

notifications Subcommand

Service Console Configuration Commands

smtp Commands

relay Command

snmp Command

remote_support Commands

Email Notification Commands

system Command

identifier Command

rest_api Command

`notifications` Subcommand

`smtp` Commands

`relay` Command

`snmp` Command

`remote_support` Commands

`system` Command

`identifier` Command

`rest_api` Command