How to get API Token from lightmesh.com
- Register and login at next.lightmesh.com
- Go to user settings on the top right corner
- Click on API Keys
- Create API Key
To use the Lightmesh CLI, export the created token. Example: export LIGHTMESH_API_TOKEN=<token>
Usage
$ npm install -g lightmesh
$ lightmesh COMMAND
running command...
$ lightmesh (--version)
lightmesh/1.0.0 darwin-arm64 node-v16.13.0
$ lightmesh --help [COMMAND]
USAGE
$ lightmesh COMMAND
...
Commands
lightmesh contact create
lightmesh contact destroy
lightmesh contact get
lightmesh contact search [SEARCH]
lightmesh contact update
lightmesh datacenter create
lightmesh datacenter destroy
lightmesh datacenter get
lightmesh datacenter search [SEARCH]
lightmesh datacenter update
lightmesh dns-entry create
lightmesh dns-entry destroy
lightmesh dns-entry get
lightmesh dns-entry search [SEARCH]
lightmesh dns-entry update
lightmesh help [COMMAND]
lightmesh interface create
lightmesh interface destroy
lightmesh interface get
lightmesh interface search [SEARCH]
lightmesh interface update
lightmesh ip-assignment create
lightmesh ip-assignment destroy
lightmesh ip-assignment get
lightmesh ip-assignment search [SEARCH]
lightmesh ip-assignment update
lightmesh ip-reservation create
lightmesh ip-reservation destroy
lightmesh ip-reservation get
lightmesh ip-reservation search [SEARCH]
lightmesh ip-reservation update
lightmesh permission-group create
lightmesh permission-group destroy
lightmesh permission-group get
lightmesh permission-group search [SEARCH]
lightmesh permission-group update
lightmesh plugins
lightmesh plugins:install PLUGIN...
lightmesh plugins:inspect PLUGIN...
lightmesh plugins:install PLUGIN...
lightmesh plugins:link PLUGIN
lightmesh plugins:uninstall PLUGIN...
lightmesh plugins:uninstall PLUGIN...
lightmesh plugins:uninstall PLUGIN...
lightmesh plugins update
lightmesh resource create
lightmesh resource destroy
lightmesh resource get
lightmesh resource search [SEARCH]
lightmesh resource update
lightmesh subnet create
lightmesh subnet destroy
lightmesh subnet get
lightmesh subnet search [SEARCH]
lightmesh subnet sync
lightmesh subnet update
lightmesh support-group create
lightmesh support-group destroy
lightmesh support-group get
lightmesh support-group search [SEARCH]
lightmesh support-group update
lightmesh zone create
lightmesh zone destroy
lightmesh zone get
lightmesh zone search [SEARCH]
lightmesh zone update
lightmesh contact create
Creates a support contact
USAGE
$ lightmesh contact create [--firstName <value>] [--lastName <value>] [--phone <value>] [--cellPhone <value>]
[--email <value>] [--email2 <value>]
FLAGS
--cellPhone=<value>
--email=<value>
--email2=<value>
--firstName=<value>
--lastName=<value>
--phone=<value>
DESCRIPTION
Creates a support contact
EXAMPLES
$ lightmesh contact create --networkAddress 10.102.0.0/16 --firstName "David" --lastName "Cole"
lightmesh contact destroy
Destroy a contact
USAGE
$ lightmesh contact destroy [--id <value>]
FLAGS
--id=<value>
DESCRIPTION
Destroy a contact
EXAMPLES
$ lightmesh contact destroy --id 5
lightmesh contact get
Get a contact by ID
USAGE
$ lightmesh contact get --id <value> [-h]
FLAGS
-h, --help Show CLI help.
--id=<value> (required)
DESCRIPTION
Get a contact by ID
EXAMPLES
$ lightmesh contact get --id 5
lightmesh contact search [SEARCH]
Search contacts
USAGE
$ lightmesh contact search [SEARCH] [-h]
FLAGS
-h, --help show CLI help
DESCRIPTION
Search contacts
EXAMPLES
$ lightmesh contact search "SGDC Private Range"!
lightmesh contact update
Update a contact
USAGE
$ lightmesh contact update --id <value> [--firstName <value>] [--lastName <value>] [--phone <value>] [--cellPhone
<value>] [--email <value>] [--email2 <value>]
FLAGS
--cellPhone=<value>
--email=<value>
--email2=<value>
--firstName=<value>
--id=<value> (required)
--lastName=<value>
--phone=<value>
DESCRIPTION
Update a contact
EXAMPLES
$ lightmesh contact update --id 5 --name "Updated Subnet Name"
lightmesh datacenter create
Creates a datacenter
USAGE
$ lightmesh datacenter create [--name <value>]
FLAGS
--name=<value>
DESCRIPTION
Creates a datacenter
EXAMPLES
$ lightmesh datacenter create --name "Example datacenter"
lightmesh datacenter destroy
Destroy a datacenter
USAGE
$ lightmesh datacenter destroy [--id <value>]
FLAGS
--id=<value>
DESCRIPTION
Destroy a datacenter
EXAMPLES
$ lightmesh datacenter destroy --id 5
lightmesh datacenter get
Get a datacenter by ID
USAGE
$ lightmesh datacenter get --id <value> [-h]
FLAGS
-h, --help Show CLI help.
--id=<value> (required)
DESCRIPTION
Get a datacenter by ID
EXAMPLES
$ lightmesh datacenter get --id 5
lightmesh datacenter search [SEARCH]
Search datacenters
USAGE
$ lightmesh datacenter search [SEARCH] [-h]
FLAGS
-h, --help show CLI help
DESCRIPTION
Search datacenters
EXAMPLES
$ lightmesh datacenter search "East Coast Datacenter"!
lightmesh datacenter update
Update a datacenter
USAGE
$ lightmesh datacenter update --id <value> [--name <value>]
FLAGS
--id=<value> (required)
--name=<value>
DESCRIPTION
Update a datacenter
EXAMPLES
$ lightmesh datacenter update --id 5 --name "Updated Subnet Name"
lightmesh dns-entry create
Create a DNS entry
USAGE
$ lightmesh dns-entry create [--$name <value>] [--$ttl <value>] [--$recordClass <value>] [--$recordType <value>]
[--$recordData <value>]
FLAGS
--$name=<value>
--$recordClass=<value>
--$recordData=<value>
--$recordType=<value>
--$ttl=<value>
DESCRIPTION
Create a DNS entry
EXAMPLES
$ lightmesh dns-entry create --name lightmesh.com --recordType A --ttl 600
lightmesh dns-entry destroy
Destroy a DNS Entry
USAGE
$ lightmesh dns-entry destroy [--id <value>]
FLAGS
--id=<value>
DESCRIPTION
Destroy a DNS Entry
EXAMPLES
$ lightmesh dns-entry destroy --id 5
lightmesh dns-entry get
Get a DNS entry by ID
USAGE
$ lightmesh dns-entry get --id <value> [-h]
FLAGS
-h, --help Show CLI help.
--id=<value> (required)
DESCRIPTION
Get a DNS entry by ID
EXAMPLES
$ lightmesh dns-entry get --id 5
lightmesh dns-entry search [SEARCH]
Search DNS Entries
USAGE
$ lightmesh dns-entry search [SEARCH] [-h]
FLAGS
-h, --help show CLI help
DESCRIPTION
Search DNS Entries
EXAMPLES
$ lightmesh dns-entry search lightmesh.com
lightmesh dns-entry update
Update a DNS entry
USAGE
$ lightmesh dns-entry update --id <value> [--$name <value>] [--$ttl <value>] [--$recordClass <value>] [--$recordType
<value>] [--$recordData <value>]
FLAGS
--$name=<value>
--$recordClass=<value>
--$recordData=<value>
--$recordType=<value>
--$ttl=<value>
--id=<value> (required)
DESCRIPTION
Update a DNS entry
EXAMPLES
$ lightmesh dns-entry update --id 5 --name "app.lightmesh.com"
lightmesh help [COMMAND]
Display help for lightmesh.
USAGE
$ lightmesh 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 lightmesh.
See code: @oclif/plugin-help
lightmesh interface create
Create an interface
USAGE
$ lightmesh interface create [--name <value>]
FLAGS
--name=<value>
DESCRIPTION
Create an interface
EXAMPLES
$ lightmesh interface create --name "eth0"
lightmesh interface destroy
Destroy an interface
USAGE
$ lightmesh interface destroy [--id <value>]
FLAGS
--id=<value>
DESCRIPTION
Destroy an interface
EXAMPLES
$ lightmesh interface destroy --id 5
lightmesh interface get
Get a interface by ID
USAGE
$ lightmesh interface get --id <value> [-h]
FLAGS
-h, --help Show CLI help.
--id=<value> (required)
DESCRIPTION
Get a interface by ID
EXAMPLES
$ lightmesh interface get --id 5
lightmesh interface search [SEARCH]
query interfaces
USAGE
$ lightmesh interface search [SEARCH] [-h]
FLAGS
-h, --help show CLI help
DESCRIPTION
query interfaces
EXAMPLES
$ lightmesh interface search "eth1"
lightmesh interface update
Update an interface
USAGE
$ lightmesh interface update --id <value> [--name <value>]
FLAGS
--id=<value> (required)
--name=<value>
DESCRIPTION
Update an interface
EXAMPLES
$ lightmesh interface update --id 5 --name eth1
lightmesh ip-assignment create
Create an IP Assignment
USAGE
$ lightmesh ip-assignment create [--$networkAddress <value>] [--$description <value>] [--$subnetId <value>]
[--$interfaceId <value>]
FLAGS
--$description=<value>
--$interfaceId=<value>
--$networkAddress=<value>
--$subnetId=<value>
DESCRIPTION
Create an IP Assignment
EXAMPLES
$ lightmesh ip-assignment create --networkAddress 10.102.0.0/16 --description "Load Balancer" --resource {'hostname': 'TEST01'}
lightmesh ip-assignment destroy
Destroy an IP Assignment
USAGE
$ lightmesh ip-assignment destroy [--id <value>]
FLAGS
--id=<value>
DESCRIPTION
Destroy an IP Assignment
EXAMPLES
$ lightmesh ip-assignment destroy --id 5
lightmesh ip-assignment get
Get an IP Assignment by ID
USAGE
$ lightmesh ip-assignment get --id <value> [-h]
FLAGS
-h, --help Show CLI help.
--id=<value> (required)
DESCRIPTION
Get an IP Assignment by ID
EXAMPLES
$ lightmesh ip-assignment get --id 5
lightmesh ip-assignment search [SEARCH]
query IP Assignments
USAGE
$ lightmesh ip-assignment search [SEARCH] [-h]
FLAGS
-h, --help show CLI help
DESCRIPTION
query IP Assignments
EXAMPLES
$ lightmesh ip-assignment search "10.100.10.1"!
lightmesh ip-assignment update
Update an IP assignment
USAGE
$ lightmesh ip-assignment update --id <value> [--name <value>]
FLAGS
--id=<value> (required)
--name=<value>
DESCRIPTION
Update an IP assignment
EXAMPLES
$ lightmesh ip-assignment update --id 5 --description "Network switch"
lightmesh ip-reservation create
Creates a reservation
USAGE
$ lightmesh ip-reservation create --name <value> --subnetId <value> [--description <value>] [--color <value>]
[--ipAddresses <value>]
FLAGS
--color=<value>
--description=<value>
--ipAddresses=<value>
--name=<value> (required)
--subnetId=<value> (required)
DESCRIPTION
Creates a reservation
EXAMPLES
$ lightmesh ip-reservation create --subnetId 1 --ipAddresses 10.102.0.1,10.102.0.2 --name "DHCP"
lightmesh ip-reservation destroy
Destroy a reservation
USAGE
$ lightmesh ip-reservation destroy [--id <value>]
FLAGS
--id=<value>
DESCRIPTION
Destroy a reservation
EXAMPLES
$ lightmesh reservation destroy --id 5
lightmesh ip-reservation get
Get a reservation by ID
USAGE
$ lightmesh ip-reservation get --id <value> [-h]
FLAGS
-h, --help Show CLI help.
--id=<value> (required)
DESCRIPTION
Get a reservation by ID
EXAMPLES
$ lightmesh reservation get --id 5
lightmesh ip-reservation search [SEARCH]
Search reservations
USAGE
$ lightmesh ip-reservation search [SEARCH] [-h]
FLAGS
-h, --help show CLI help
DESCRIPTION
Search reservations
EXAMPLES
$ lightmesh reservations search DHCP
lightmesh ip-reservation update
Update a reservation
USAGE
$ lightmesh ip-reservation update --id <value> --name <value> --subnetId <value> [--description <value>] [--color
<value>] [--ipAddresses <value>]
FLAGS
--color=<value>
--description=<value>
--id=<value> (required)
--ipAddresses=<value>
--name=<value> (required)
--subnetId=<value> (required)
DESCRIPTION
Update a reservation
EXAMPLES
$ lightmesh reservation update --id 5 --name "Updated Reservation Name"
lightmesh permission-group create
Create a permission-group
USAGE
$ lightmesh permission-group create [--name <value>] [--networkAddress <value>]
FLAGS
--name=<value>
--networkAddress=<value>
DESCRIPTION
Create a permission-group
EXAMPLES
$ lightmesh permission-group create --networkAddress 10.102.0.0/16 --name "Example permission group"
lightmesh permission-group destroy
Destroy a permission group
USAGE
$ lightmesh permission-group destroy [--id <value>]
FLAGS
--id=<value>
DESCRIPTION
Destroy a permission group
EXAMPLES
$ lightmesh permission group destroy --id 5
lightmesh permission-group get
Get a permission group by ID
USAGE
$ lightmesh permission-group get --id <value> [-h]
FLAGS
-h, --help Show CLI help.
--id=<value> (required)
DESCRIPTION
Get a permission group by ID
EXAMPLES
$ lightmesh permission-group get --id 5
lightmesh permission-group search [SEARCH]
Search permission groups
USAGE
$ lightmesh permission-group search [SEARCH] [-h]
FLAGS
-h, --help show CLI help
DESCRIPTION
Search permission groups
EXAMPLES
$ lightmesh permission group search "Administrators"
lightmesh permission-group update
Update a permission group
USAGE
$ lightmesh permission-group update --id <value> [--name <value>]
FLAGS
--id=<value> (required)
--name=<value>
DESCRIPTION
Update a permission group
EXAMPLES
$ lightmesh permission-group update --id 5 --name "Admins"
lightmesh plugins
List installed plugins.
USAGE
$ lightmesh plugins [--core]
FLAGS
--core Show core plugins.
DESCRIPTION
List installed plugins.
EXAMPLES
$ lightmesh plugins
See code: @oclif/plugin-plugins
lightmesh plugins:install PLUGIN...
Installs a plugin into the CLI.
USAGE
$ lightmesh plugins:install PLUGIN...
ARGUMENTS
PLUGIN Plugin to install.
FLAGS
-f, --force Run yarn install with force flag.
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Installs a plugin into the CLI.
Can be installed from npm or a git url.
Installation of a user-installed plugin will override a core plugin.
e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
the CLI without the need to patch and update the whole CLI.
ALIASES
$ lightmesh plugins add
EXAMPLES
$ lightmesh plugins:install myplugin
$ lightmesh plugins:install https://github.com/someuser/someplugin
$ lightmesh plugins:install someuser/someplugin
lightmesh plugins:inspect PLUGIN...
Displays installation properties of a plugin.
USAGE
$ lightmesh plugins:inspect PLUGIN...
ARGUMENTS
PLUGIN [default: .] Plugin to inspect.
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Displays installation properties of a plugin.
EXAMPLES
$ lightmesh plugins:inspect myplugin
lightmesh plugins:install PLUGIN...
Installs a plugin into the CLI.
USAGE
$ lightmesh plugins:install PLUGIN...
ARGUMENTS
PLUGIN Plugin to install.
FLAGS
-f, --force Run yarn install with force flag.
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Installs a plugin into the CLI.
Can be installed from npm or a git url.
Installation of a user-installed plugin will override a core plugin.
e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
the CLI without the need to patch and update the whole CLI.
ALIASES
$ lightmesh plugins add
EXAMPLES
$ lightmesh plugins:install myplugin
$ lightmesh plugins:install https://github.com/someuser/someplugin
$ lightmesh plugins:install someuser/someplugin
lightmesh plugins:link PLUGIN
Links a plugin into the CLI for development.
USAGE
$ lightmesh plugins:link PLUGIN
ARGUMENTS
PATH [default: .] path to plugin
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Links a plugin into the CLI for development.
Installation of a linked plugin will override a user-installed or core plugin.
e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
command will override the user-installed or core plugin implementation. This is useful for development work.
EXAMPLES
$ lightmesh plugins:link myplugin
lightmesh plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ lightmesh plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ lightmesh plugins unlink
$ lightmesh plugins remove
lightmesh plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ lightmesh plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ lightmesh plugins unlink
$ lightmesh plugins remove
lightmesh plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ lightmesh plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ lightmesh plugins unlink
$ lightmesh plugins remove
lightmesh plugins update
Update installed plugins.
USAGE
$ lightmesh plugins update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.
lightmesh resource create
Create a resource
USAGE
$ lightmesh resource create [--name <value>] [--hostname <value>]
FLAGS
--hostname=<value>
--name=<value>
DESCRIPTION
Create a resource
EXAMPLES
$ lightmesh resource create --hostname "EXAMPLE01"
lightmesh resource destroy
Destroy a resource
USAGE
$ lightmesh resource destroy [--id <value>]
FLAGS
--id=<value>
DESCRIPTION
Destroy a resource
EXAMPLES
$ lightmesh resource destroy --id 5
lightmesh resource get
Get a resource by ID
USAGE
$ lightmesh resource get --id <value> [-h]
FLAGS
-h, --help Show CLI help.
--id=<value> (required)
DESCRIPTION
Get a resource by ID
EXAMPLES
$ lightmesh resource get --id 5
lightmesh resource search [SEARCH]
query resources
USAGE
$ lightmesh resource search [SEARCH] [-h]
FLAGS
-h, --help show CLI help
DESCRIPTION
query resources
EXAMPLES
$ lightmesh resource search EXAMPLE01
lightmesh resource update
Update a resource
USAGE
$ lightmesh resource update --id <value> [--hostname <value>]
FLAGS
--hostname=<value>
--id=<value> (required)
DESCRIPTION
Update a resource
EXAMPLES
$ lightmesh resource update --id 5 --name "Updated Subnet Name"
lightmesh subnet create
Create a subnet
USAGE
$ lightmesh subnet create [--name <value>] [--networkAddress <value>]
FLAGS
--name=<value>
--networkAddress=<value>
DESCRIPTION
Create a subnet
EXAMPLES
$ lightmesh subnet create --networkAddress 10.102.0.0/16 --name "Example subnet"
lightmesh subnet destroy
Destroy a subnet
USAGE
$ lightmesh subnet destroy [--id <value>]
FLAGS
--id=<value>
DESCRIPTION
Destroy a subnet
EXAMPLES
$ lightmesh subnet destroy --id 5
lightmesh subnet get
Get a subnet by ID
USAGE
$ lightmesh subnet get --id <value> [-h]
FLAGS
-h, --help Show CLI help.
--id=<value> (required)
DESCRIPTION
Get a subnet by ID
EXAMPLES
$ lightmesh subnet get --id 5
lightmesh subnet search [SEARCH]
query subnets
USAGE
$ lightmesh subnet search [SEARCH] [-h]
FLAGS
-h, --help show CLI help
DESCRIPTION
query subnets
EXAMPLES
$ lightmesh subnet search "SGDC Private Range"!
lightmesh subnet sync
Sync a subnet using an nmap result file
USAGE
$ lightmesh subnet sync --id <value> --file <value> [-h]
FLAGS
-h, --help Show CLI help.
--file=<value> (required)
--id=<value> (required)
DESCRIPTION
Sync a subnet using an nmap result file
EXAMPLES
$ lightmesh subnet sync --id 5
lightmesh subnet update
Update a subnet
USAGE
$ lightmesh subnet update --id <value> [--name <value>]
FLAGS
--id=<value> (required)
--name=<value>
DESCRIPTION
Update a subnet
EXAMPLES
$ lightmesh subnet update --id 5 --name "Updated Subnet Name"
lightmesh support-group create
Create a support group
USAGE
$ lightmesh support-group create [--name <value>] [--networkAddress <value>]
FLAGS
--name=<value>
--networkAddress=<value>
DESCRIPTION
Create a support group
EXAMPLES
$ lightmesh support-group create --name "Example support group"
lightmesh support-group destroy
Destroy a support group
USAGE
$ lightmesh support-group destroy [--id <value>]
FLAGS
--id=<value>
DESCRIPTION
Destroy a support group
EXAMPLES
$ lightmesh support-group destroy --id 5
lightmesh support-group get
Get a support group by ID
USAGE
$ lightmesh support-group get --id <value> [-h]
FLAGS
-h, --help Show CLI help.
--id=<value> (required)
DESCRIPTION
Get a support group by ID
EXAMPLES
$ lightmesh support-group get --id 5
lightmesh support-group search [SEARCH]
Search support groups
USAGE
$ lightmesh support-group search [SEARCH] [-h]
FLAGS
-h, --help show CLI help
DESCRIPTION
Search support groups
EXAMPLES
$ lightmesh support-group search "SGDC Private Range"!
lightmesh support-group update
Update a support group
USAGE
$ lightmesh support-group update --id <value> [--name <value>]
FLAGS
--id=<value> (required)
--name=<value>
DESCRIPTION
Update a support group
EXAMPLES
$ lightmesh support-group update --id 5 --name "IT Group"
lightmesh zone create
Create a zone
USAGE
$ lightmesh zone create [--name <value>] [--networkAddress <value>]
FLAGS
--name=<value>
--networkAddress=<value>
DESCRIPTION
Create a zone
EXAMPLES
$ lightmesh zone create --name "Example zone"
lightmesh zone destroy
Destroy a zone
USAGE
$ lightmesh zone destroy [--id <value>]
FLAGS
--id=<value>
DESCRIPTION
Destroy a zone
EXAMPLES
$ lightmesh zone destroy --id 5
lightmesh zone get
Get a zone by ID
USAGE
$ lightmesh zone get --id <value> [-h]
FLAGS
-h, --help Show CLI help.
--id=<value> (required)
DESCRIPTION
Get a zone by ID
EXAMPLES
$ lightmesh zone get --id 5
lightmesh zone search [SEARCH]
Search zones
USAGE
$ lightmesh zone search [SEARCH] [-h]
FLAGS
-h, --help show CLI help
DESCRIPTION
Search zones
EXAMPLES
$ lightmesh zone search "SGDC Private Range"!
lightmesh zone update
Update a zone
USAGE
$ lightmesh zone update --id <value> [--name <value>]
FLAGS
--id=<value> (required)
--name=<value>
DESCRIPTION
Update a zone
EXAMPLES
$ lightmesh zone update --id 5 --name "Updated Zone Name"