Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

 

One Command to command whole Open-O !!
Model-driven CLI

Both telco and enterprise customers prefer commands over GUI on many situations such as automation, CI, etc. And Open-O CLI provides required Command-Line Interface(CLI) as commands to operate Open-O functionalities from Unix or windows shell.

 


Slack channel: #openo-cli
Mailing List: openo-client@list.open-o,org 

Script Mode

Code Block
languagetext
themeEmacs
$ openo -h
Open-O Command-line interface (CLI).

One Command to command whole Open-O !! It provides the unified commands
to access and operate Open-O functionalities. To use this CLI, please
configure the following environment variables:

1. OPENO_MSB_URL - Open-O Micro service bus(MSB) URL
2. OPENO_USERNAME - Open-O user name
3. OPENO_PASSWORD - Open-O user password

To know the CLI version, type openo [-v|--version]
To know the CLI usage, type openo [-h|--help]
To know the usage of sub commands, type openo <command> [-h|--help]

To know more, please refer the Open-O wiki https://wiki.open-o.org


Open-O sub-commands:
+----------------------------+------------------+----------------------------------------------------+
|NAME                        |SERVICE           |DESCRIPTION                                         |
+----------------------------+------------------+----------------------------------------------------+
|catalog-csar-create         |catalog v1        |Upload csar packages from Open-O                    |
+----------------------------+------------------+----------------------------------------------------+
|catalog-csar-delete         |catalog v1        |Delete csar package from Open-O                     |
+----------------------------+------------------+----------------------------------------------------+
|catalog-csar-list           |catalog v1        |List csar packages from Open-O                      |
+----------------------------+------------------+----------------------------------------------------+
|catalog-csar-show           |catalog v1        |Retrieves CSAR package from Open-O                  |
+----------------------------+------------------+----------------------------------------------------+
|catalog-template-list       |catalog v1        |List service templates from Open-O                  |
+----------------------------+------------------+----------------------------------------------------+
|catalog-template-show       |catalog v1        |Retrieves the details of template from Open-O       |
+----------------------------+------------------+----------------------------------------------------+
|microservice-create         |msb v1            |Register microservice into Open-O                   |
+----------------------------+------------------+----------------------------------------------------+
|microservice-delete         |msb v1            |Deletes the micro service from Open-O               |
+----------------------------+------------------+----------------------------------------------------+
|microservice-list           |msb v1            |Lists the registetred micro services in Open-O      |
+----------------------------+------------------+----------------------------------------------------+
|microservice-show           |msb v1            |Details the registered microservice in Open-O       |
+----------------------------+------------------+----------------------------------------------------+
|resource-datacenter-create  |resmgr v1         |Create the nfvo resource datacenter                 |
+----------------------------+------------------+----------------------------------------------------+
|resource-datacenter-delete  |resmgr v1         |Delete the nfvo resource datacenter                 |
+----------------------------+------------------+----------------------------------------------------+
|resource-datacenter-list    |resmgr v1         |List nfvo datacenters                               |
+----------------------------+------------------+----------------------------------------------------+
|resource-datacenter-show    |resmgr v1         |Show datacenter details                             |
+----------------------------+------------------+----------------------------------------------------+
|resource-link-create        |sdnobrs v1        |Create sdno resource topological link               |
+----------------------------+------------------+----------------------------------------------------+
|resource-link-delete        |sdnobrs v1        |Delete sdno resource topological link               |
+----------------------------+------------------+----------------------------------------------------+
|resource-link-list          |sdnobrs v1        |List sdno resource topological links                |
+----------------------------+------------------+----------------------------------------------------+
|resource-link-show          |sdnobrs v1        |Show sdno resource topological link                 |
+----------------------------+------------------+----------------------------------------------------+
|resource-ne-create          |sdnobrs v1        |Create the sdno network elements                    |
+----------------------------+------------------+----------------------------------------------------+
|resource-ne-delete          |sdnobrs v1        |Delete the sdno network elements                    |
+----------------------------+------------------+----------------------------------------------------+
|resource-ne-list            |sdnobrs v1        |List the sdno network elements                      |
+----------------------------+------------------+----------------------------------------------------+
|resource-ne-show            |sdnobrs v1        |Show network element details                        |
+----------------------------+------------------+----------------------------------------------------+
|resource-port-create        |sdnobrs v1        |Create the sdno port                                |
+----------------------------+------------------+----------------------------------------------------+
|resource-port-delete        |sdnobrs v1        |Delete the sdno port                                |
+----------------------------+------------------+----------------------------------------------------+
|resource-port-list          |sdnobrs v1        |List the sdno ports                                 |
+----------------------------+------------------+----------------------------------------------------+
|resource-port-show          |sdnobrs v1        |Show port details                                   |
+----------------------------+------------------+----------------------------------------------------+
|resource-site-create        |sdnobrs v1        |Create sdno resource site                           |
+----------------------------+------------------+----------------------------------------------------+
|resource-site-delete        |sdnobrs v1        |Delete sdno resource site                           |
+----------------------------+------------------+----------------------------------------------------+
|resource-site-list          |sdnobrs v1        |List sdno resource sites                            |
+----------------------------+------------------+----------------------------------------------------+
|resource-site-show          |sdnobrs v1        |Show sdno resource site                             |
+----------------------------+------------------+----------------------------------------------------+
|role-list                   |auth v1           |List Open-O user roles                              |
+----------------------------+------------------+----------------------------------------------------+
|schema-refresh              |openo-cli 1.0.0   |Open-O command to refresh schemas stored in         |
|                            |                  |openo_cli_schema folders.                           |
+----------------------------+------------------+----------------------------------------------------+
|schema-validate             |openo-cli 1.0.0   |Open-O command to validate schema                   |
+----------------------------+------------------+----------------------------------------------------+
|sdnc-create                 |extsys v1         |Register SDNC into Open-O                           |
+----------------------------+------------------+----------------------------------------------------+
|sdnc-delete                 |extsys v1         |Removes the given SDNC from Open-O                  |
+----------------------------+------------------+----------------------------------------------------+
|sdnc-list                   |extsys v1         |Retrieves the registered SDN controllers in Open-O  |
+----------------------------+------------------+----------------------------------------------------+
|sdnc-show                   |extsys v1         |Retrieves the given SDNC details from Open-O        |
+----------------------------+------------------+----------------------------------------------------+
|service-create              |gso v1            |Create the network service                          |
+----------------------------+------------------+----------------------------------------------------+
|service-delete              |gso v1            |Delete the network service                          |
+----------------------------+------------------+----------------------------------------------------+
|service-list                |gso v1            |List network services                               |
+----------------------------+------------------+----------------------------------------------------+
|service-show                |gso v1            |Show network service                                |
+----------------------------+------------------+----------------------------------------------------+
|user-create                 |auth v1           |Creates Open-O user.                                |
+----------------------------+------------------+----------------------------------------------------+
|vim-create                  |extsys v1         |Register VIM into Open-O                            |
+----------------------------+------------------+----------------------------------------------------+
|vim-delete                  |extsys v1         |Removes the given VIM from Open-O                   |
+----------------------------+------------------+----------------------------------------------------+
|vim-list                    |extsys v1         |Retrieves the registered VIMs in Open-O             |
+----------------------------+------------------+----------------------------------------------------+
|vim-show                    |extsys v1         |Retrieves the given VIM details from Open-O         |
+----------------------------+------------------+----------------------------------------------------+
|vnfm-create                 |extsys v1         |Register VNFM into Open-O                           |
+----------------------------+------------------+----------------------------------------------------+
|vnfm-delete                 |extsys v1         |Removes the given VNFM from Open-O                  |
+----------------------------+------------------+----------------------------------------------------+
|vnfm-list                   |extsys v1         |Retrieves registered VNFM from Open-O               |
+----------------------------+------------------+----------------------------------------------------+
|vnfm-show                   |extsys v1         |Retrieves the given VNFM details from Open-O        |
+----------------------------+------------------+----------------------------------------------------+

Interactive Mode

Code Block
languagetext
themeEmacs
$ openo -i
openo>
catalog-csar-create          catalog-csar-delete
catalog-csar-list            catalog-csar-show
catalog-template-list        catalog-template-show
clear                        exit
microservice-create          microservice-delete
microservice-list            microservice-show
resource-datacenter-create   resource-datacenter-delete
resource-datacenter-list     resource-datacenter-show
resource-link-create         resource-link-delete
resource-link-list           resource-link-show
resource-ne-create           resource-ne-delete
resource-ne-list             resource-ne-show
resource-port-create         resource-port-delete
resource-port-list           resource-port-show
resource-site-create         resource-site-delete
resource-site-list           resource-site-show
role-list                    schema-refresh
schema-validate              sdnc-create
sdnc-delete                  sdnc-list
sdnc-show                    service-create
service-delete               service-list
service-show                 user-create
vim-create                   vim-delete
vim-list                     vim-show
vnfm-create                  vnfm-delete
vnfm-list                    vnfm-show