It is a (rather crude), interactive shell wrtiten as a wrapper around Golang libraries for Nuage Networks API (see e.g. https://github.com/FlorianOtel/nuage_v3_2 for version v3.2 of the API). Based on abiosoft/ishell
The main purpose of this "shell" is to test those libraries and showcase their usage.
Currently only version v3.2 of the Nuage Networks API is implemented -- in terms of both the underlying library and, respectively, support in this shell. Other versions of the API will be implemented as they are released and/or requested.
This is provided "as such", without any official support.
Thanks in advance for feedback, questions or raising issues -- much appreciated.
There are two types of shell commands:
-
Auxiliary commands for E.g.: Displaying the details of (existing) API connection. Currently a single API connection is supported at one time; Setting the debug level (only two levels supported -- a verbose "Debug" level and "Info"); Setting the API connection details (API endpoint and credentials) and initializing a connection
-
Wrappers around the Nuage Networks API calls themselves: "GET", "CREATE", "DELETE" etc. See below for commands currently supported.
Nuage API Interactive Shell
>> help
Commands:
CREATE DELETE GET clear debuglevel displayconn exit greet help makeconn setconn
>> debuglevel
Set debug level: Debug, Info (default): Debug
Debug level now set to: Debug
>> displayconn
Endpoint URL: [https://127.0.0.1:8443]
API version: [v3_2]
Not connected
>> setconn
Set Nuage API connection Details: Endpoint IP address ; User + Password ; Nuage API version
Enter your VSD IP address> 127.0.0.1
Enter your Enterprise (organization) name. Leave empty if default > org
Enter your username. Leave empty if default > user
Enter your password. Leave empty if default > pass
>> makeconn
DEBU[0017] Attempting to make connection to: https://127.0.0.1:8443/nuage/api/v1_0/me
DEBU[0017] Response Status: 200 OK
DEBU[0017] Response Headers: map[Server:[Apache-Coyote/1.1] Pragma:[No-cache] Set-Cookie:[rememberMe=deleteMe; Path=/nuage; Max-Age=0; Expires=Thu, 15-Oct-2015 10:29:54 GMT] Access-Control-Allow-Origin:[*] Vary:[Accept-Encoding] Cache-Control:[no-cache] Expires:[Thu, 01 Jan 1970 00:00:00 UTC] Access-Control-Expose-Headers:[X-Nuage-Organization, X-Nuage-ProxyUser, X-Nuage-OrderBy, X-Nuage-FilterType, X-Nuage-Filter, X-Nuage-Page, X-Nuage-PageSize, X-Nuage-Count, X-Nuage-Custom] Content-Type:[application/json] Date:[Fri, 16 Oct 2015 10:29:54 GMT]]
DEBU[0017] Response body: nuage.Authtoken{Apikey:"3f8160e9-da6a-426e-9d53-30dc76ca2e1c", APIKeyExpiry:1445068088806, Id:"8a6f0e20-a4db-4878-ad84-9cc61756cd5e", AvatarData:"", AvatarType:"", Email:"user@CSP.com", EnterpriseID:"76046673-d0ea-4a67-b6af-2829952f0812", EnterpriseName:"CSP", EntityScop:"", ExternalID:"", ExternalId:"", FirstName:"user", LastName:"user", MobileNumber:"", Password:"", Role:"USER", UserName:"user"}
Nuage API connection established
Each command has a 1-1 correspondence with the underlying library calls.
They require that a valid API connection is established first (using the makeconn command above).
Currently the following shell commands are supported. For more details and examples on how they use the API library please see main.go
#### GET operations
GET enterprises
GET enterprises <ID>
GET enterprises <ID> domaintemplates
GET enterprises <ID> domains
GET domains
GET domains <ID>
GET domains <ID> vports
GET domains <ID> vminterfaces
GET domaintemplates <ID>
GET domaintemplates <ID> zonetemplates
GET zonetemplates <ID>
GET zones
GET zones <ID>
GET subnets
GET subnets <ID>
GET subnets <ID> vports
GET subnets <ID> vminterfaces
GET vminterfaces
GET vms
GET vms <ID>
#### CREATE operations
CREATE enterprise <Name>
CREATE domaintemplate <Name> <Parent Enterprise ID>
CREATE domain <Name> <Parent Enterprise ID> <Domain template ID>
CREATE zonetemplate <Name> <Parent domain template ID>
CREATE zone <Name> <Parent Domain ID> [ <Zone template ID> ]
CREATE subnet <Name> <Parent Zone ID> <Subnet template ID>
CREATE subnet <Name> <Parent Zone ID> <Address> <Netmask>
CREATE vport <Name> <Parent Subnet ID> [ options ...]
### OBS: Temporary syntax
CREATE vm <Name> <UUID> <Interface0-MAC> <Interface0-VPortID>
#### DELETE operations
DELETE enterprise <ID>
DELETE domaintemplate <ID>
DELETE zonetemplate <ID>
DELETE domain <ID>
DELETE zone <ID>
DELETE subnet <ID>
DELETE vport <ID>
DELETE vminterface <ID>
DELETE vm <ID>
Example: Obtaining the list of organizations (enterprises) currently defined:
>> GET enterprises
===> Org nr [0]: Name [ORG1] <===
{
"allowedForwardingClasses": [
"H"
],
"associatedEnterpriseSecurityID": "429fb71e-9613-4ff6-80a6-dda00075b1e4",
"associatedGroupKeyEncryptionProfileID": "f915f3a7-8314-4a24-b853-51e913ba4e16",
"associatedKeyServerMonitorID": "f9a88422-548f-407e-aa00-146fcd479f7c",
"customerID": 10004,
"description": "20150911",
"DHCPLeaseinterval": 24,
"encryptionManagementMode": "DISABLED",
"enterpriseProfileID": "f1e5eb19-c67a-4651-90c1-3f84e23e1d36",
"floatingIPsQuota": 16,
"name": "ORG1",
"receiveMultiCastListID": "081169f6-cb2f-4c6e-8e94-b701224a5141",
"sendMultiCastListID": "738446cc-026f-488f-9718-b13f4390857b",
"creationDate": 1442002567000,
"lastUpdatedBy": "8a6f0e20-a4db-4878-ad84-9cc61756cd5e",
"lastUpdatedDate": 1442002905000,
"owner": "8a6f0e20-a4db-4878-ad84-9cc61756cd5e",
"entityScope": "ENTERPRISE",
"ID": "ea6862a3-b215-4343-b54f-3cee1d9ef9be"
}
===> Org nr [1]: Name [ORG2] <===
{
"allowedForwardingClasses": [
"H"
],
"associatedEnterpriseSecurityID": "626af6e0-74f8-4008-8122-ca89a2e40c28",
"associatedGroupKeyEncryptionProfileID": "a82f8626-772d-4505-a4e5-9b22c1daca63",
"associatedKeyServerMonitorID": "7788e5e5-91d1-4f9b-ab13-14efff7784bb",
"customerID": 10005,
"description": "Test org #2",
"DHCPLeaseinterval": 24,
"encryptionManagementMode": "DISABLED",
"enterpriseProfileID": "f1e5eb19-c67a-4651-90c1-3f84e23e1d36",
"floatingIPsQuota": 16,
"name": "ORG2",
"receiveMultiCastListID": "081169f6-cb2f-4c6e-8e94-b701224a5141",
"sendMultiCastListID": "738446cc-026f-488f-9718-b13f4390857b",
"creationDate": 1443106911000,
"lastUpdatedBy": "8a6f0e20-a4db-4878-ad84-9cc61756cd5e",
"lastUpdatedDate": 1443106911000,
"owner": "8a6f0e20-a4db-4878-ad84-9cc61756cd5e",
"entityScope": "ENTERPRISE",
"ID": "30d5ac86-edfa-49e0-afcc-786b63b41e9a"
}
Enterprise list -- done
>>