リファレンス / local-router
コマンド一覧
- Basic Commands
- Monitoring Commands
- Other Commands
list
Usage
Usage:
list [flags]
Aliases:
list, ls, find, select
Flags:
=== Filter options ===
--names strings
--tags strings
=== Limit/Offset options ===
--count int (aliases: --max, --limit)
--from int (aliases: --offset)
=== Input options ===
--generate-skeleton Output skeleton of parameters with JSON format (aliases: --skeleton)
--parameters string Input parameters in JSON format
=== Output options ===
--format string Output format in Go templates (aliases: --fmt)
-o, --output-type string Output format options: [table/json/yaml] (aliases: --out)
--query string Query for JSON output
--query-driver string Name of the driver that handles queries to JSON output options: [jmespath/jq]
-q, --quiet Output IDs only
=== Parameter example ===
--example Output example parameters with JSON format
create
Usage
Usage:
create [flags]
Flags:
=== Common options ===
--name string (*required)
--description string
--tags strings
--icon-id int
=== Local-Router-specific options ===
--ip-addresses strings
--netmask int (aliases: --network-mask-len)
--peers string
--static-routes string
--switch-category string
--switch-code string
--switch-zone-id string
--virtual-ip-address string
--vrid int
=== Input options ===
-y, --assumeyes Assume that the answer to any question which would be asked is yes
--generate-skeleton Output skeleton of parameters with JSON format (aliases: --skeleton)
--parameters string Input parameters in JSON format
=== Output options ===
--format string Output format in Go templates (aliases: --fmt)
-o, --output-type string Output format options: [table/json/yaml] (aliases: --out)
--query string Query for JSON output
--query-driver string Name of the driver that handles queries to JSON output options: [jmespath/jq]
-q, --quiet Output IDs only
=== Parameter example ===
--example Output example parameters with JSON format
Parameter Examples
{
"Name": "example",
"Description": "example",
"Tags": [
"tag1=example1",
"tag2=example2"
],
"IconID": 123456789012,
"Switch": {
"Code": "123456789012",
"Category": "cloud",
"ZoneID": "tk1a | tk1b | is1a | is1b | tk1v"
},
"Interface": {
"VirtualIPAddress": "192.0.2.101",
"IPAddress": [
"192.0.2.21",
"192.0.2.22"
],
"NetworkMaskLen": 24,
"VRID": 1
},
"Peers": [
{
"ID": 123456789012,
"SecretKey": "*****",
"Enabled": true,
"Description": "example-peer"
}
],
"StaticRoutes": [
{
"Prefix": "192.0.2.0/24",
"NextHop": "192.0.2.1"
}
]
}
read
Usage
Usage:
read { ID | NAME | TAG } [flags]
Aliases:
read, show
Flags:
=== Input options ===
--generate-skeleton Output skeleton of parameters with JSON format (aliases: --skeleton)
--parameters string Input parameters in JSON format
=== Output options ===
--format string Output format in Go templates (aliases: --fmt)
-o, --output-type string Output format options: [table/json/yaml] (aliases: --out)
--query string Query for JSON output
--query-driver string Name of the driver that handles queries to JSON output options: [jmespath/jq]
-q, --quiet Output IDs only
=== Parameter example ===
--example Output example parameters with JSON format
update
Usage
Usage:
update { ID | NAME | TAG }... [flags]
Flags:
=== Common options ===
--name string
--description string
--tags strings
--icon-id int
=== Local-Router-specific options ===
--ip-addresses strings
--netmask int (aliases: --network-mask-len)
--peers string
--static-routes string
--switch-category string
--switch-code string
--switch-zone-id string
--virtual-ip-address string
--vrid int
=== Input options ===
-y, --assumeyes Assume that the answer to any question which would be asked is yes
--generate-skeleton Output skeleton of parameters with JSON format (aliases: --skeleton)
--parameters string Input parameters in JSON format
=== Output options ===
--format string Output format in Go templates (aliases: --fmt)
-o, --output-type string Output format options: [table/json/yaml] (aliases: --out)
--query string Query for JSON output
--query-driver string Name of the driver that handles queries to JSON output options: [jmespath/jq]
-q, --quiet Output IDs only
=== Parameter example ===
--example Output example parameters with JSON format
Parameter Examples
{
"Name": "example",
"Description": "example",
"Tags": [
"tag1=example1",
"tag2=example2"
],
"IconID": 123456789012,
"Switch": {
"Code": "123456789012",
"Category": "cloud",
"ZoneID": "tk1a | tk1b | is1a | is1b | tk1v"
},
"Interface": {
"VirtualIPAddress": "192.0.2.101",
"IPAddress": [
"192.0.2.21",
"192.0.2.22"
],
"NetworkMaskLen": 24,
"VRID": 1
},
"Peers": [
{
"ID": 123456789012,
"SecretKey": "*****",
"Enabled": true,
"Description": "example-peer"
}
],
"StaticRoutes": [
{
"Prefix": "192.0.2.0/24",
"NextHop": "192.0.2.1"
}
]
}
delete
Usage
Usage:
delete { ID | NAME | TAG }... [flags]
Aliases:
delete, rm
Flags:
=== Error handling options ===
--fail-if-not-found
=== Input options ===
-y, --assumeyes Assume that the answer to any question which would be asked is yes
--generate-skeleton Output skeleton of parameters with JSON format (aliases: --skeleton)
--parameters string Input parameters in JSON format
=== Output options ===
--format string Output format in Go templates (aliases: --fmt)
-o, --output-type string Output format options: [table/json/yaml] (aliases: --out)
--query string Query for JSON output
--query-driver string Name of the driver that handles queries to JSON output options: [jmespath/jq]
-q, --quiet Output IDs only
=== Parameter example ===
--example Output example parameters with JSON format
monitor-local-router
Usage
Usage:
monitor-local-router { ID | NAME | TAG }... [flags]
Aliases:
monitor-local-router, monitor
Flags:
=== Monitor options ===
--end string
--start string
=== Input options ===
--generate-skeleton Output skeleton of parameters with JSON format (aliases: --skeleton)
--parameters string Input parameters in JSON format
=== Output options ===
--format string Output format in Go templates (aliases: --fmt)
-o, --output-type string Output format options: [table/json/yaml] (aliases: --out)
--query string Query for JSON output
--query-driver string Name of the driver that handles queries to JSON output options: [jmespath/jq]
-q, --quiet Output IDs only
=== Parameter example ===
--example Output example parameters with JSON format
health
Usage
Usage:
health { ID | NAME | TAG }... [flags]
Flags:
=== Input options ===
--generate-skeleton Output skeleton of parameters with JSON format (aliases: --skeleton)
--parameters string Input parameters in JSON format
=== Output options ===
--format string Output format in Go templates (aliases: --fmt)
-o, --output-type string Output format options: [table/json/yaml] (aliases: --out)
--query string Query for JSON output
--query-driver string Name of the driver that handles queries to JSON output options: [jmespath/jq]
-q, --quiet Output IDs only
=== Parameter example ===
--example Output example parameters with JSON format