Skip to content

Commit

Permalink
Update Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
cdgco committed Apr 5, 2024
1 parent 3d4f5ce commit 118d2ad
Show file tree
Hide file tree
Showing 12 changed files with 701 additions and 814 deletions.
837 changes: 24 additions & 813 deletions README.md

Large diffs are not rendered by default.

26 changes: 26 additions & 0 deletions docs/help.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
`rmagent help`
==============

Display help for rmagent.

* [`rmagent help [COMMAND]`](#rmagent-help-command)

## `rmagent help [COMMAND]`

Display help for rmagent.

```
USAGE
$ rmagent help [COMMAND...] [-n]
ARGUMENTS
COMMAND... Command to show help for.
FLAGS
-n, --nested-commands Include all nested commands in the output.
DESCRIPTION
Display help for rmagent.
```

_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.0.20/src/commands/help.ts)_
70 changes: 70 additions & 0 deletions docs/ipmi.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
`rmagent ipmi`
==============

Manage IPMI settings for servers

* [`rmagent ipmi list`](#rmagent-ipmi-list)
* [`rmagent ipmi set`](#rmagent-ipmi-set)
* [`rmagent ipmi test`](#rmagent-ipmi-test)

## `rmagent ipmi list`

List IPMI accounts

```
USAGE
$ rmagent ipmi list
DESCRIPTION
List IPMI accounts
EXAMPLES
$ rmagent ipmi list
```

_See code: [src/commands/ipmi/list.ts](https://github.com/cdgco/RackManage-Agent/blob/v0.0.1/src/commands/ipmi/list.ts)_

## `rmagent ipmi set`

Set IPMI account for a server

```
USAGE
$ rmagent ipmi set [-a <value>] [-f <value>] [-p <value>] [-p <value>] [-s <value>] [-u <value>]
FLAGS
-a, --address=<value> IPMI address
-f, --flags=<value> Extra ipmitool flags
-p, --password=<value> IPMI password
-p, --port=<value> Port to monitor
-s, --server=<value> Server address
-u, --username=<value> IPMI username
DESCRIPTION
Set IPMI account for a server
EXAMPLES
$ rmagent ipmi set
```

_See code: [src/commands/ipmi/set.ts](https://github.com/cdgco/RackManage-Agent/blob/v0.0.1/src/commands/ipmi/set.ts)_

## `rmagent ipmi test`

Test IPMI connection

```
USAGE
$ rmagent ipmi test [-s <value>]
FLAGS
-s, --server=<value> Server address
DESCRIPTION
Test IPMI connection
EXAMPLES
$ rmagent ipmi test
```

_See code: [src/commands/ipmi/test.ts](https://github.com/cdgco/RackManage-Agent/blob/v0.0.1/src/commands/ipmi/test.ts)_
26 changes: 26 additions & 0 deletions docs/login.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
`rmagent login`
===============

Connect agent to Rack Manage account

* [`rmagent login [TOKEN]`](#rmagent-login-token)

## `rmagent login [TOKEN]`

Connect agent to Rack Manage account

```
USAGE
$ rmagent login [TOKEN]
ARGUMENTS
TOKEN Agent token
DESCRIPTION
Connect agent to Rack Manage account
EXAMPLES
$ rmagent login
```

_See code: [src/commands/login.ts](https://github.com/cdgco/RackManage-Agent/blob/v0.0.1/src/commands/login.ts)_
23 changes: 23 additions & 0 deletions docs/logout.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
`rmagent logout`
================

Disconnect agent from Rack Manage account

* [`rmagent logout`](#rmagent-logout)

## `rmagent logout`

Disconnect agent from Rack Manage account

```
USAGE
$ rmagent logout
DESCRIPTION
Disconnect agent from Rack Manage account
EXAMPLES
$ rmagent logout
```

_See code: [src/commands/logout.ts](https://github.com/cdgco/RackManage-Agent/blob/v0.0.1/src/commands/logout.ts)_
Loading

0 comments on commit 118d2ad

Please sign in to comment.