Scalable Activation

  • 3 minute(s) read
Prev Next

The Enterprise Node includes a feature that allows you to activate an instance and associate it with a node via the command line.

Prerequisites

  • Lynx or later installed on a supported operating system
  • APIv2 Key (available from the Catchpoint portal)

Usage

The Catchpoint utility includes the following commands for instance activation:

  • catchpoint activate
    Activates a new instance and associates it with a node.
  • catchpoint lookup
    Queries for the various options required to complete the catchpoint activate command

Details for each of these commands can be found by adding the --help argument to the command.

Your APIv2 key must be included with any lookup or activate command using the --api-key parameter.

Activation

There are four different ways to activate an instance:

  1. Activate an instance and create a new node using the local machine’s ID and hostname (as reported by Catchpoint info).
# catchpoint activate --api-key API_KEY --new-node vm-qa-actest-10 --city pittsburgh --country "united states" --size 4 --isp "Comcast Business" --os "RHEL 8"
  1. Activate an instance and create a new node and specify the machine ID and hostname
# catchpoint activate --api-key API_KEY --new-node new-node-name --city pittsburgh --country "united states" --size 4 --isp "Comcast Business" --os "RHEL 8" --machine-id 1234567890FF --hostname "machine-hostname"
  1. Activate an instance against an existing node using the local machine’s ID and hostname (as reported by catchpoint info)
# catchpoint activate --api-key API_KEY --node existing-node-name --city pittsburgh --country "united states" --os "RHEL 8"
  1. Activate an instance against an existing node and specify the machine ID and hostname
# catchpoint activate --api-key API_KEY --node existing-node-name --city pittsburgh --country "united states" --os "RHEL 8" --machine-id 1234567890FF --hostname "machine-hostname"

The combination of all parameters must result in a unique entry. For example, specifying the city as “York” but not including the state “New York” will result in a failure to activate, because there are multiple matches for “York” in the United States. The lookup command documented in the next section can be used to validate these parameters.

Lookup

The lookup command is used to query for the various parameters required to complete the activate request. The results are returned in JSON format.

These options are the same as what is available in the Catchpoint Portal for node activation.

The following options are available for lookup: Location, ISP, OS, and Node.

Location

Location consists of three parameters: city, country, and state.

Using all three parameters:

# catchpoint lookup --api-key API_KEY --city "York" --country "united states" --state "new york"
Looking Up Location: york new york united states
[
  "CITY: york STATE: new york COUNTRY: united states"
]

Using city and country:

# catchpoint lookup --api-key API_KEY --city "york" --country "united states"
Looking Up Location: york  united states
ERROR: Multiple Results, try filtering further by country/state
[
  "CITY: york STATE: alabama COUNTRY: united states",
  "CITY: york STATE: nebraska COUNTRY: united states",
  "CITY: york STATE: maine COUNTRY: united states",
  "CITY: york STATE: new york COUNTRY: united states",
  "CITY: york STATE: north dakota COUNTRY: united states",
  "CITY: york STATE: pennsylvania COUNTRY: united states",
  "CITY: york STATE: south carolina COUNTRY: united states"
]

To activate a node, your lookup must return a single item.

ISP

ISP takes a single argument, which is the name of the ISP you want to search for:

# catchpoint lookup --api-key API_KEY --isp "comcast business"
Looking up Internet Service Provider: comcast business
[
  "comcast business"
]

OS

OS takes a single argument, which is the name/version of Operating System you want to search for:

# catchpoint lookup --api-key API_KEY --os "RHEL 8"
Looking up Operating System: RHEL 8
[
  "RHEL 8"
]

With multiple results:

# catchpoint lookup --api-key API_KEY --os "c"
Looking up Operating System: c
ERROR: Multiple Operating Systems Found, further refine using the results list!
[
  "Catchpoint Appliance",
  "RHEL 8",
  "Oracle 8"
]

To activate a node, your lookup must return a single item.

Node

Searching for a node requires three parameters: node name, city, and country:

# catchpoint lookup --api-key API_KEY --node vm-jred-actest-11 --city pittsburgh --country "united states"
Looking up Node by node_name: vm-jred-actest-11
[
  {
    "NODE": "vm-jred-actest-11",
    "LOCATION": "CITY: Pittsburgh STATE: Pennsylvania COUNTRY: United States",
    "ISP": "Comcast Business",
    "SIZE": "6",
    "IPV6": "true"
  }
]

With multiple results:

# catchpoint lookup --stage --api-key FBDAD724DB84E47EEE71A90AA23451F376F4F16AE6187F527B6755F8E2DD4B92 --node jred
 --city pittsburgh --country "united states"
Looking up Node by node_name: jred
ERROR: Multiple Nodes Found, further refine using the results list!
[
  {
    "NODE": "vm-jred-actest-10",
    "LOCATION": "CITY: Pittsburgh STATE: Pennsylvania COUNTRY: United States",
    "ISP": "Comcast Business",
    "SIZE": "4",
    "IPV6": "false"
  },
  {
    "NODE": "vm-jred-actest-11",
    "LOCATION": "CITY: Pittsburgh STATE: Pennsylvania COUNTRY: United States",
    "ISP": "Comcast Business",
    "SIZE": "6",
    "IPV6": "true"
  },
  {
    "NODE": "vm-jred-actest-15",
    "LOCATION": "CITY: Pittsburgh STATE: Pennsylvania COUNTRY: United States",
    "ISP": "Comcast Business",
    "SIZE": "4",
    "IPV6": "false"
  },
  {
    "NODE": "vm-node-jred-ac-test03",
    "LOCATION": "CITY: Pittsburgh STATE: Pennsylvania COUNTRY: United States",
    "ISP": "Comcast Business",
    "SIZE": "4",
    "IPV6": "true"
  }
]