starlingx/docs
Code Issues Proposed changes
docs/doc/source/cli_ref/fm.rst
Kristal Dale 859c02a692 Add initial CLI ref content 
Add initial content for CLI commands: system, fm,
dcmanager

Story: 2006888
Task: 37501

Change-Id: I334bd4e9657abcfc7928b8706bc4aedee02a97da
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2019-12-06 11:54:51 -08:00

1.8 KiB
Raw Blame History

fm

fm is the command-line interface for Fault Management.

This page documents the fm command in StarlingX R3.0.

fm usage

fm [--version] [--debug] [-v] [--timeout TIMEOUT]
        [--os-username OS_USERNAME] [--os-password OS_PASSWORD]
        [--os-tenant-id OS_TENANT_ID] [--os-tenant-name OS_TENANT_NAME]
        [--os-auth-url OS_AUTH_URL] [--os-region-name OS_REGION_NAME]
        [--os-auth-token OS_AUTH_TOKEN] [--fm-url FM_URL]
        [--fm-api-version FM_API_VERSION]
        [--os-service-type OS_SERVICE_TYPE]
        [--os-endpoint-type OS_ENDPOINT_TYPE]
        [--os-user-domain-id OS_USER_DOMAIN_ID]
        [--os-user-domain-name OS_USER_DOMAIN_NAME]
        [--os-project-id OS_PROJECT_ID] [--os-project-name OS_PROJECT_NAME]
        [--os-project-domain-id OS_PROJECT_DOMAIN_ID]
        [--os-project-domain-name OS_PROJECT_DOMAIN_NAME]
        <subcommand> ...

For a list of all fm subcommands and options, enter:

fm help

Subcommands

For a full description of usage and optional arguments for a specific fm command, enter:

fm help COMMAND

Alarm and event display

alarm-delete

Delete an active alarm.

alarm-list

List all active alarms.

alarm-show

Show an active alarm.

alarm-summary

Show a summary of active alarms.

event-list

List event logs.

event-show

Show a event log.

event-suppress

Suppress specified event ID's.

event-suppress-list

List Suppressed event ID's

event-unsuppress

Unsuppress specified event ID's.

event-unsuppress-all

Unsuppress all event ID's.