npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

lightmesh

v3.2.1

Published

Tools to manage your network with the Lightmesh API

Downloads

313

Readme

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>

Version Downloads/week

Usage

$ npm install -g lightmesh
$ lightmesh COMMAND
running command...
$ lightmesh (--version)
lightmesh/3.2.1 linux-x64 node-v18.20.4
$ lightmesh --help [COMMAND]
USAGE
  $ lightmesh COMMAND
...

Commands

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 --firstName "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
  --id=<value>           (required)
  --name=<value>
  --recordClass=<value>
  --recordData=<value>
  --recordType=<value>
  --ttl=<value>

DESCRIPTION
  Update a DNS entry

EXAMPLES
  $ lightmesh dns-entry update --id 5 --name "app.lightmesh.com"

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-address search SEARCH

query IP Addresses

USAGE
  $ lightmesh ip-address search SEARCH [-h] [-o <value>] [-z <value>] [--subnet_id <value>] [-j]

FLAGS
  -h, --help                Show CLI help.
  -j, --json                Output in JSON format
  -o, --output=<value>      output file name
  -z, --subnetName=<value>  Subnet for filtering
  --subnet_id=<value>

DESCRIPTION
  query IP Addresses

EXAMPLES
  $ lightmesh ip-address search --subnetName="Subnet 1"!,
       $ lightmesh ip-address search --subnetName="Subnet 1" --output="AllSubnets.csv"!

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] [-o <value>] [-z <value>] [-j] [-y <value>]

FLAGS
  -h, --help              Show CLI help.
  -j, --json              Output in JSON format
  -o, --output=<value>    output file name
  -y, --zoneName=<value>  Zone for filtering
  -z, --subnet=<value>    Subnet for filtering

DESCRIPTION
  query IP Assignments

EXAMPLES
  $ lightmesh ip-assignment search "10.100.10.1"! 

  $ lightmesh ip-assignment search --subnet="10.0.0.0/16" --output=all_ipassignments.csv

  $ lightmesh ip-assignment search --zoneName="DCN" --output=all_ipassignments.csv

  $ lightmesh ip-assignment search --subnet="10.0.0.0/16" --json

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 login

User login

USAGE
  $ lightmesh login [--sessionid <value>]

FLAGS
  --sessionid=<value>  Session ID obtained from the browser

DESCRIPTION
  User login

EXAMPLES
  $ lightmesh user login

lightmesh logout

User Logout

USAGE
  $ lightmesh logout

DESCRIPTION
  User Logout

EXAMPLES
  $ lightmesh user logout

lightmesh plugins

List installed plugins.

USAGE
  $ lightmesh plugins [--json] [--core]

FLAGS
  --core  Show core plugins.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ lightmesh plugins

See code: @oclif/plugin-plugins

lightmesh plugins add PLUGIN

Installs a plugin into lightmesh.

USAGE
  $ lightmesh plugins add PLUGIN... [--json] [-f] [-h] [-s | -v]

ARGUMENTS
  PLUGIN...  Plugin to install.

FLAGS
  -f, --force    Force npm to fetch remote resources even if a local copy exists on disk.
  -h, --help     Show CLI help.
  -s, --silent   Silences npm output.
  -v, --verbose  Show verbose npm output.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Installs a plugin into lightmesh.

  Uses npm to install plugins.

  Installation of a user-installed plugin will override a core plugin.

  Use the LIGHTMESH_NPM_LOG_LEVEL environment variable to set the npm loglevel.
  Use the LIGHTMESH_NPM_REGISTRY environment variable to set the npm registry.

ALIASES
  $ lightmesh plugins add

EXAMPLES
  Install a plugin from npm registry.

    $ lightmesh plugins add myplugin

  Install a plugin from a github url.

    $ lightmesh plugins add https://github.com/someuser/someplugin

  Install a plugin from a github slug.

    $ lightmesh plugins add 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

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Displays installation properties of a plugin.

EXAMPLES
  $ lightmesh plugins inspect myplugin

See code: @oclif/plugin-plugins

lightmesh plugins install PLUGIN

Installs a plugin into lightmesh.

USAGE
  $ lightmesh plugins install PLUGIN... [--json] [-f] [-h] [-s | -v]

ARGUMENTS
  PLUGIN...  Plugin to install.

FLAGS
  -f, --force    Force npm to fetch remote resources even if a local copy exists on disk.
  -h, --help     Show CLI help.
  -s, --silent   Silences npm output.
  -v, --verbose  Show verbose npm output.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Installs a plugin into lightmesh.

  Uses npm to install plugins.

  Installation of a user-installed plugin will override a core plugin.

  Use the LIGHTMESH_NPM_LOG_LEVEL environment variable to set the npm loglevel.
  Use the LIGHTMESH_NPM_REGISTRY environment variable to set the npm registry.

ALIASES
  $ lightmesh plugins add

EXAMPLES
  Install a plugin from npm registry.

    $ lightmesh plugins install myplugin

  Install a plugin from a github url.

    $ lightmesh plugins install https://github.com/someuser/someplugin

  Install a plugin from a github slug.

    $ lightmesh plugins install someuser/someplugin

See code: @oclif/plugin-plugins

lightmesh plugins link PATH

Links a plugin into the CLI for development.

USAGE
  $ lightmesh plugins link PATH [-h] [--install] [-v]

ARGUMENTS
  PATH  [default: .] path to plugin

FLAGS
  -h, --help          Show CLI help.
  -v, --verbose
      --[no-]install  Install dependencies after linking the plugin.

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

See code: @oclif/plugin-plugins

lightmesh plugins remove [PLUGIN]

Removes a plugin from the CLI.

USAGE
  $ lightmesh plugins remove [PLUGIN...] [-h] [-v]

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

EXAMPLES
  $ lightmesh plugins remove myplugin

lightmesh plugins reset

Remove all user-installed and linked plugins.

USAGE
  $ lightmesh plugins reset [--hard] [--reinstall]

FLAGS
  --hard       Delete node_modules and package manager related files in addition to uninstalling plugins.
  --reinstall  Reinstall all plugins after uninstalling.

See code: @oclif/plugin-plugins

lightmesh plugins uninstall [PLUGIN]

Removes a plugin from the CLI.

USAGE
  $ lightmesh plugins uninstall [PLUGIN...] [-h] [-v]

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

EXAMPLES
  $ lightmesh plugins uninstall myplugin

See code: @oclif/plugin-plugins

lightmesh plugins unlink [PLUGIN]

Removes a plugin from the CLI.

USAGE
  $ lightmesh plugins unlink [PLUGIN...] [-h] [-v]

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

EXAMPLES
  $ lightmesh plugins unlink myplugin

lightmesh plugins update

Update installed plugins.

USAGE
  $ lightmesh plugins update [-h] [-v]

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Update installed plugins.

See code: @oclif/plugin-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 scan-result create

Create an scan-result

USAGE
  $ lightmesh scan-result create [--networkAddress <value>] [--subnetId <value>] [--zoneId <value>] [--hostname <value>]
    [--macAddress <value>] [--interface <value>] [--resourceType <value>] [--sourceType <value>] [--ignore] [--scannedAt
    <value>] [--ScanId <value>]

FLAGS
  --ScanId=<value>
  --hostname=<value>
  --ignore
  --interface=<value>
  --macAddress=<value>
  --networkAddress=<value>
  --resourceType=<value>
  --scannedAt=<value>
  --sourceType=<value>
  --subnetId=<value>
  --zoneId=<value>

DESCRIPTION
  Create an scan-result

EXAMPLES
  $ lightmesh scan-result create --networkAddress 10.0.0.1 --zoneId 1 --hostname ECDCVM01

lightmesh scan-result destroy

Destroy an scan-result

USAGE
  $ lightmesh scan-result destroy [--id <value>]

FLAGS
  --id=<value>

DESCRIPTION
  Destroy an scan-result

EXAMPLES
  $ lightmesh scan-result destroy --id 5

lightmesh scan-result get

Get a scan-result by ID

USAGE
  $ lightmesh scan-result get --id <value> [-h]

FLAGS
  -h, --help        Show CLI help.
      --id=<value>  (required)

DESCRIPTION
  Get a scan-result by ID

EXAMPLES
  $ lightmesh scan-result get --id 5

lightmesh scan-result search SEARCH

query scan-results

USAGE
  $ lightmesh scan-result search SEARCH [-h]

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  query scan-results

EXAMPLES
  $ lightmesh scan-result search --networkAddress 10.0.0.0/16 --zoneId 1

lightmesh scan-result update

Update an scan-result

USAGE
  $ lightmesh scan-result update --id <value> [--name <value>]

FLAGS
  --id=<value>    (required)
  --name=<value>

DESCRIPTION
  Update an scan-result

EXAMPLES
  $ lightmesh scan-result update --id 5 --name eth1

lightmesh scan create

Create an scan

USAGE
  $ lightmesh scan create [--sourceType <value>] [--sourceVersion <value>] [--scanCommand <value>]
    [--networkAddress <value>] [--scannedAt <value>]

FLAGS
  --networkAddress=<value>
  --scanCommand=<value>
  --scannedAt=<value>
  --sourceType=<value>
  --sourceVersion=<value>

DESCRIPTION
  Create an scan

EXAMPLES
  $ lightmesh scan create --sourceType "nmap" --sourceVersion "10.1" --scanCommand "nmap -sn scanme.nmap.org -oX nmap-scan.xml" --networkAddress "10.0.0.1"

lightmesh scan destroy

Destroy an scan

USAGE
  $ lightmesh scan destroy [--id <value>]

FLAGS
  --id=<value>

DESCRIPTION
  Destroy an scan

EXAMPLES
  $ lightmesh scan destroy --id 5

lightmesh scan get

Get a scan by ID

USAGE
  $ lightmesh scan get --id <value> [-h]

FLAGS
  -h, --help        Show CLI help.
      --id=<value>  (required)

DESCRIPTION
  Get a scan by ID

EXAMPLES
  $ lightmesh scan get --id 5

lightmesh scan search SEARCH

query scans

USAGE
  $ lightmesh scan search SEARCH [-h]

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  query scans

EXAMPLES
  $ lightmesh scan search "eth1"

lightmesh scan sync

Sync a subnet using an nmap result file

USAGE
  $ lightmesh scan 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 scan sync --id 5 --file my-network.xml

lightmesh scan update

Update an scan

USAGE
  $ lightmesh scan update --id <value> [--name <value>]

FLAGS
  --id=<value>    (required)
  --name=<value>

DESCRIPTION
  Update an scan

EXAMPLES
  $ lightmesh scan update --id 5 --name eth1

lightmesh subnet create

Create a subnet

USAGE
  $ lightmesh subnet create [--name <value>] [--networkAddress <value>] [--supernetId <value>] [--zoneId <value>]
    [--zoneName <value>]

FLAGS
  --name=<value>
  --networkAddress=<value>
  --supernetId=<value>
  --zoneId=<value>
  --zoneName=<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] [-o <value>] [-z <value>] [-j]

FLAGS
  -h, --help              Show CLI help.
  -j, --json              Output in JSON format
  -o, --output=<value>    output file name
  -z, --zoneName=<value>  Zone name for filtering

DESCRIPTION
  query subnets

EXAMPLES
  $ lightmesh subnet search "192.68.86.0/24"

  $ lightmesh subnet search --zoneName=myZone --output=all_subnets.csv

  $ lightmesh subnet search --zoneName=myZone --json

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 user-group create

Create a user-group

USAGE
  $ lightmesh user-group create [--name <value>] [--networkAddress <value>]

FLAGS
  --name=<value>
  --networkAddress=<value>

DESCRIPTION
  Create a user-group

EXAMPLES
  $ lightmesh user-group create --networkAddress 10.102.0.0/16 --name "Example user group"

lightmesh user-group destroy

Destroy a user group

USAGE
  $ lightmesh user-group destroy [--id <value>]

FLAGS
  --id=<value>

DESCRIPTION
  Destroy a user group

EXAMPLES
  $ lightmesh user group destroy --id 5

lightmesh user-group get

Get a user group by ID

USAGE
  $ lightmesh user-group get --id <value> [-h]

FLAGS
  -h, --help        Show CLI help.
      --id=<value>  (required)

DESCRIPTION
  Get a user group by ID

EXAMPLES
  $ lightmesh user-group get --id 5

lightmesh user-group search SEARCH

Search user groups

USAGE
  $ lightmesh user-group search SEARCH [-h]

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  Search user groups

EXAMPLES
  $ lightmesh user group search "Administrators"

lightmesh user-group update

Update a user group

USAGE
  $ lightmesh user-group update --id <value> [--name <value>]

FLAGS
  --id=<value>    (required)
  --name=<value>

DESCRIPTION
  Update a user group

EXAMPLES
  $ lightmesh user-group update --id 5 --name "Admins"

lightmesh zone create

Create a zone

USAGE
  $ lightmesh zone create [--name <value>] [--VRF <value>] [--networkAddress <value>]

FLAGS
  --VRF=<value>
  --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>] [--VRF <value>]

FLAGS
  --VRF=<value>
  --id=<value>    (required)
  --name=<value>

DESCRIPTION
  Update a zone

EXAMPLES
  $ lightmesh zone update --id 5 --name "Updated Zone Name"