OGCLI

ogcli allows you to inspect and modify the configuration tree from the command line.

Commands within the ogcli tool

• -h, --help            show this help message and exit

• --notation            show the simple notation reference and exit

• --list, --list-endpoints         

  • list endpoints

• --usage               show usage examples and exit

• -d                    increase debugging (up to 2 times)

• -j                    use JSON instead of simple notation (pass twice to pretty-print output)

• -u USERNAME, --username USERNAME

  • authenticate as a different user

• -p PASSWORD, --password PASSWORD

  • authenticate with the supplied password

• -n NEW_PASSWORD, --new-password NEW_PASSWORD

  • authenticate with the supplied new password

• sub-commands:

  • operation

  • get (g)             fetch a list or item

  • replace (r)             replace a list or item

  • update (u)          update an item

  • create (c)          create an item

  • delete (d)          delete a list or item

  • list                list endpoints

Run ogcli operation -h for help on that operation

Available endpoints

Here is the full list of available endpoints that can be used with the ogcli sub-commands:

ENDPOINT	OPERATIONS	ARGS
alerts/authentication	get/replace
alerts/config_change	get/replace
alerts/networking	get/replace
alerts/system	get/replace
auth	get/replace
auto_response/beacons	get/merge/delete
auto_response/beacon	create/get/replace/delete	id
auto_response/reactions	get/merge/delete
auto_response/reaction	create/get/replace/delete	id
auto_response/status	get
auto_response/status/beacon-modules	get
auto_response/status/beacons	get	id
cellfw/info	get
conns	get/merge
conn	create/get/replace/delete	id
export	get
failover/settings	get/replace
failover/status	get
firewall/policies	get/merge
firewall/policy	create/get/replace/delete	id
firewall/predefined_services	get
firewall/rules	get/merge/delete
firewall/rule	create/get/replace/delete	id
firewall/services	get/merge
firewall/service	create/get/replace/delete	id
firewall/zones	get/merge
firewall/zone	create/get/replace/delete	id
groups	get/merge/replace
group	create/get/replace/delete	id
ip_passthrough	get/replace
ip_passthrough/status	get
ipsec_tunnels	get/merge
ipsec_tunnel	create/get/replace/delete	id
lighthouse_enrollments	get
lighthouse_enrollment	create/get/delete	id
logs/portlog	get	id
managementports	get/merge
managementport	get/replace	id
monitor/lldp/chassis	get
monitor/lldp/neighbor	get
pdus	get/merge
pdu	create/get/replace/delete	id
physifs	get/merge
physif	create/get/replace/delete	id
ports	get/merge
port	get/replace	id
port_power	replace	id
port_sessions	get/delete
port_session	get/delete	idpid
ports/auto_discover/schedule	get/replace
ports/fields	get
search/ports	get
services/https	get/replace
services/lldp	get/replace
services/ntp	get/replace
services/routing	get/replace
services/snmp_manager	get/replace
services/snmpd	get/replace
services/ssh	get/replace
services/syslog_servers	get/merge
services/syslog_server	create/get/replace/delete	syslog_server_id
ssh/authorized_keys	get/merge
ssh/authorized_key	create/delete	user-idkey-id
static_routes	get/merge/replace/delete
static_route	create/get/replace/delete	id
system/admin_info	get/replace
system/banner	get/replace
system/cell_reliability_test	get/replace
system/cli_session_timeout	get/replace
system/firmware_upgrade_status	get
system/hostname	get/replace
system/model_name	get
system/serial_number	get
system/ssh_port	get/replace
system/system_authorized_keys	get/merge
system/system_authorized_key	create/delete	key-id
system/time	get/replace
system/timezone	get/replace
system/version	get
system/webui_session_timeout	get/replace
users	get/merge/replace
user	create/get/replace/delete	user-id

Using ogcli

ogcli examples:

Replace MOTD

Replace the MOTD displayed during log in:

ogcli replace banner 'banner="DESIRED MESSAGE HERE"'

Retrieve items

ogcli get users > record_list ogcli get user users-1 > record

Replace items

ogcli set users < record_list ogcli set user users-1 < record Modify items:

ogcli update user users-1 < partial_record ogcli update user users-1 'field="value"' Create items:

ogcli create user < record

Delete items

ogcli delete user users-1

Merge items in a list:

ogcli merge syslog < list of records

Export all config:

ogcli export [/path/to/file]

Import config:

ogcli import [/path/to/file]

ogcli import < [/path/to/file]

ogcli takes records from stdin so a variety of options are available when passing records.

ogcli create user < record

ogcli create user << ‘END’ username="root" description="superuser" END

echo 'username="root" description="superuser"' | ogcli create user

ogcli takes records from stdin so a variety of options are available. ogcli also takes records from any extra command line arguments.

Note: Double-quotes around strings should be protected from the shell.

ogcli create user 'username="root"' 'description="superuser"'

Merge items in a list

ogcli merge syslog < list of records

Export all config

ogcli export [/path/to/file]

Import config

ogcli import [/path/to/file]

ogcli import < [/path/to/file]

ogcli takes records from stdin so a variety of options are available when passing records. ogcli create user < record

ogcli create user << ‘END’ username="root" description="superuser" END

echo 'username="root" description="superuser"' | ogcli create user

ogcli takes records from stdin so a variety of options are available. ogcli also takes records from any extra command line arguments.

Note: Double-quotes around strings should be protected from the shell.