Longview
This section details Longview-related Linode CLI commands.
list
Aliases: ls
Returns a paginated list of Longview Clients you have access to.
Usage
The format accepted by this command.
linode-cli longview list [-h] [--label label]
[--order-by {label}] [--order {asc,desc}]
Sample
Examples of how this command might be used.
linode-cli longview list
Filterable Attributes
Arguments used to define a filter for response entries.
Name |
Type |
Description |
|---|---|---|
--label |
str |
This Client’s unique label. |
Result Attributes
The attributes returned by this command.
Name |
Type |
Example |
Description |
|---|---|---|---|
api_key |
str |
BD1B4B54-D752…D8A17F39DB61 |
The API key for this Client, used when configuring the Longview Client application on your Linode. |
created |
str |
2018-01-01T00:01:01 |
When this Longview Client was created. |
id |
int |
789 |
This Client’s unique ID. |
install_code |
str |
BD1B5605-BF5E…AD518BE7F321 |
The install code for this Client, used when configuring the Longview Client application on your Linode. |
label |
str |
client789 |
This Client’s unique label. |
updated |
str |
2018-01-01T00:01:01 |
When this Longview Client was last updated. |
apps
Name |
Type |
Example |
Description |
|---|---|---|---|
apps.apache |
bool |
true |
If True, the Apache Longview Client module is monitoring Apache on your server. |
apps.mysql |
bool |
true |
If True, the MySQL Longview Client modules is monitoring MySQL on your server. |
apps.nginx |
bool |
N/A |
If True, the Nginx Longview Client module is monitoring Nginx on your server. |
view
Returns a single Longview Client you can access.
Usage
The format accepted by this command.
linode-cli longview view [-h] [--label label]
[--order-by {label}] [--order {asc,desc}] clientId
Sample
Examples of how this command might be used.
linode-cli longview view 789
Parameters
Positional parameters used to define the resource this command should target.
Name |
Type |
Description |
|---|---|---|
clientId |
int |
The Longview Client ID to access. |
Result Attributes
The attributes returned by this command.
Name |
Type |
Example |
Description |
|---|---|---|---|
api_key |
str |
BD1B4B54-D752…D8A17F39DB61 |
The API key for this Client, used when configuring the Longview Client application on your Linode. |
created |
str |
2018-01-01T00:01:01 |
When this Longview Client was created. |
id |
int |
789 |
This Client’s unique ID. |
install_code |
str |
BD1B5605-BF5E…AD518BE7F321 |
The install code for this Client, used when configuring the Longview Client application on your Linode. |
label |
str |
client789 |
This Client’s unique label. |
updated |
str |
2018-01-01T00:01:01 |
When this Longview Client was last updated. |
apps
Name |
Type |
Example |
Description |
|---|---|---|---|
apps.apache |
bool |
true |
If True, the Apache Longview Client module is monitoring Apache on your server. |
apps.mysql |
bool |
true |
If True, the MySQL Longview Client modules is monitoring MySQL on your server. |
apps.nginx |
bool |
N/A |
If True, the Nginx Longview Client module is monitoring Nginx on your server. |
create
Creates a Longview Client.
Usage
The format accepted by this command.
linode-cli longview create [-h] [--label label]
Sample
Examples of how this command might be used.
linode-cli longview create \
--label client789
Arguments
Additional fields used to execute this request.
Name |
Type |
Example |
Description |
|---|---|---|---|
--label |
str |
client789 |
This Client’s unique label. |
Result Attributes
The attributes returned by this command.
Name |
Type |
Example |
Description |
|---|---|---|---|
api_key |
str |
BD1B4B54-D752…D8A17F39DB61 |
The API key for this Client, used when configuring the Longview Client application on your Linode. |
created |
str |
2018-01-01T00:01:01 |
When this Longview Client was created. |
id |
int |
789 |
This Client’s unique ID. |
install_code |
str |
BD1B5605-BF5E…AD518BE7F321 |
The install code for this Client, used when configuring the Longview Client application on your Linode. |
label |
str |
client789 |
This Client’s unique label. |
updated |
str |
2018-01-01T00:01:01 |
When this Longview Client was last updated. |
apps
Name |
Type |
Example |
Description |
|---|---|---|---|
apps.apache |
bool |
true |
If True, the Apache Longview Client module is monitoring Apache on your server. |
apps.mysql |
bool |
true |
If True, the MySQL Longview Client modules is monitoring MySQL on your server. |
apps.nginx |
bool |
N/A |
If True, the Nginx Longview Client module is monitoring Nginx on your server. |
update
Updates a Longview Client.
Usage
The format accepted by this command.
linode-cli longview update [-h] [--label label] clientId
Sample
Examples of how this command might be used.
linode-cli longview update 789 \
--label client789
Parameters
Positional parameters used to define the resource this command should target.
Name |
Type |
Description |
|---|---|---|
clientId |
int |
The Longview Client ID to access. |
Arguments
Additional fields used to execute this request.
Name |
Type |
Example |
Description |
|---|---|---|---|
--label |
str |
client789 |
This Client’s unique label. |
Result Attributes
The attributes returned by this command.
Name |
Type |
Example |
Description |
|---|---|---|---|
api_key |
str |
BD1B4B54-D752…D8A17F39DB61 |
The API key for this Client, used when configuring the Longview Client application on your Linode. |
created |
str |
2018-01-01T00:01:01 |
When this Longview Client was created. |
id |
int |
789 |
This Client’s unique ID. |
install_code |
str |
BD1B5605-BF5E…AD518BE7F321 |
The install code for this Client, used when configuring the Longview Client application on your Linode. |
label |
str |
client789 |
This Client’s unique label. |
updated |
str |
2018-01-01T00:01:01 |
When this Longview Client was last updated. |
apps
Name |
Type |
Example |
Description |
|---|---|---|---|
apps.apache |
bool |
true |
If True, the Apache Longview Client module is monitoring Apache on your server. |
apps.mysql |
bool |
true |
If True, the MySQL Longview Client modules is monitoring MySQL on your server. |
apps.nginx |
bool |
N/A |
If True, the Nginx Longview Client module is monitoring Nginx on your server. |
delete
Aliases: rm
Deletes a Longview Client from your Account.
Usage
The format accepted by this command.
linode-cli longview delete [-h] clientId
Sample
Examples of how this command might be used.
linode-cli longview delete 789
Parameters
Positional parameters used to define the resource this command should target.
Name |
Type |
Description |
|---|---|---|
clientId |
int |
The Longview Client ID to access. |
plan-view
Get the details of your current Longview plan.
Usage
The format accepted by this command.
linode-cli longview plan-view [-h] [--order-by {}]
[--order {asc,desc}]
Sample
Examples of how this command might be used.
linode-cli longview plan-view
Result Attributes
The attributes returned by this command.
Name |
Type |
Example |
Description |
|---|---|---|---|
clients_included |
int |
10 |
The number of Longview Clients that may be created with this Subscription tier. |
id |
str |
longview-10 |
The unique ID of this Subscription tier. |
label |
str |
Longview Pro 10 pack |
A display name for this Subscription tier. |
price
Name |
Type |
Example |
Description |
|---|---|---|---|
price.hourly |
float |
0.06 |
The hourly price, in US dollars, for this Subscription tier. |
price.monthly |
float |
40 |
The maximum monthly price in US Dollars for this Subscription tier. |
plan-update
Update your Longview plan to that of the given subscription ID.
Usage
The format accepted by this command.
linode-cli longview plan-update [-h]
[--longview_subscription longview_subscription]
Sample
Examples of how this command might be used.
linode-cli longview plan-update --longview_subscription longview-10
Arguments
Additional fields used to execute this request.
Name |
Type |
Example |
Description |
|---|---|---|---|
--longview_subscription |
str |
longview-10 |
(nullable) The subscription ID for a particular Longview plan. |
Result Attributes
The attributes returned by this command.
Name |
Type |
Example |
Description |
|---|---|---|---|
clients_included |
int |
10 |
The number of Longview Clients that may be created with this Subscription tier. |
id |
str |
longview-10 |
The unique ID of this Subscription tier. |
label |
str |
Longview Pro 10 pack |
A display name for this Subscription tier. |
price
Name |
Type |
Example |
Description |
|---|---|---|---|
price.hourly |
float |
0.06 |
The hourly price, in US dollars, for this Subscription tier. |
price.monthly |
float |
40 |
The maximum monthly price in US Dollars for this Subscription tier. |
subscription-view
Get the Longview plan details as a single LongviewSubscription object for the provided subscription ID.
Usage
The format accepted by this command.
linode-cli longview subscription-view [-h] [--order-by {}]
[--order {asc,desc}] subscriptionId
Sample
Examples of how this command might be used.
linode-cli longview subscription-view \
longview-10
Parameters
Positional parameters used to define the resource this command should target.
Name |
Type |
Description |
|---|---|---|
subscriptionId |
str |
The Longview Subscription to look up. |
Result Attributes
The attributes returned by this command.
Name |
Type |
Example |
Description |
|---|---|---|---|
clients_included |
int |
10 |
The number of Longview Clients that may be created with this Subscription tier. |
id |
str |
longview-10 |
The unique ID of this Subscription tier. |
label |
str |
Longview Pro 10 pack |
A display name for this Subscription tier. |
price
Name |
Type |
Example |
Description |
|---|---|---|---|
price.hourly |
float |
0.06 |
The hourly price, in US dollars, for this Subscription tier. |
price.monthly |
float |
40 |
The maximum monthly price in US Dollars for this Subscription tier. |
subscriptions-list
Returns a paginated list of available Longview Subscriptions.
Usage
The format accepted by this command.
linode-cli longview subscriptions-list [-h] [--order-by {}]
[--order {asc,desc}]
Sample
Examples of how this command might be used.
linode-cli longview subscriptions-list
Result Attributes
The attributes returned by this command.
Name |
Type |
Example |
Description |
|---|---|---|---|
clients_included |
int |
10 |
The number of Longview Clients that may be created with this Subscription tier. |
id |
str |
longview-10 |
The unique ID of this Subscription tier. |
label |
str |
Longview Pro 10 pack |
A display name for this Subscription tier. |
price
Name |
Type |
Example |
Description |
|---|---|---|---|
price.hourly |
float |
0.06 |
The hourly price, in US dollars, for this Subscription tier. |
price.monthly |
float |
40 |
The maximum monthly price in US Dollars for this Subscription tier. |