networking¶
networking bond-ifs get¶
Usage
usage: -c networking bond-ifs get [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
bond_if_id
Description
Get information for a specific bond interface
Return
Returns dict
Optional
optional arguments:
-h, --help show this help message and exit
networking bond-ifs list¶
Usage
usage: -c networking bond-ifs list [-h]
[-f {adaptive_table,csv,json,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--node NODE] [--name NAME] [--order ORDER]
[--sort-by SORT_BY] [--marker MARKER]
[--limit LIMIT]
Description
Get a list of all bond interfaces.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--node NODE Filter by a node's UUID.
--name NAME Perform a query to get the member of a list that has this name.
--order ORDER The sorting order for get response.
--sort-by SORT_BY The field by which to sort.
--marker MARKER Specify the first entity that you want to retrieve.
--limit LIMIT Specify the number of entities that you want to retrieve.
networking control agents-reset¶
Usage
usage: -c networking control agents-reset [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX] [--state STATE]
Description
FORCE Set agents state to up.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--state STATE Force setting current state
networking control agents-restart¶
Usage
usage: -c networking control agents-restart [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--force]
Description
Move all stratonet services to maintenance and Shut down all agents and dependant services.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--force Force restarting agents regardless of current state
networking control agents-shutdown¶
Usage
usage: -c networking control agents-shutdown [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>]
[--noindent] [--prefix PREFIX]
Description
Move all stratonet services to maintenance and Shut down all agents and dependant services.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
networking control agents-state¶
Usage
usage: -c networking control agents-state [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
Description
Get agents state.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
networking discovery list¶
Usage
usage: -c networking discovery list [-h]
[-f {adaptive_table,csv,json,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--order ORDER] [--sort-by SORT_BY]
[--marker MARKER] [--limit LIMIT]
[--vlan VLAN] [--node NODE]
[--vlan-id VLAN_ID] [--if-id IF_ID]
Description
Get the list of discovered cluster VLANs on each host
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--order ORDER The sorting order for get response.
--sort-by SORT_BY The field by which to sort.
--marker MARKER Specify the first entity that you want to retrieve.
--limit LIMIT Specify the number of entities that you want to retrieve.
--vlan VLAN Filter by VLAN UUID.
--node NODE Filter by a node's UUID.
--vlan-id VLAN_ID
--if-id IF_ID Filter by Ethernet interface's UUID.
networking ethernet-ifs get¶
Usage
usage: -c networking ethernet-ifs get [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
ethernet_if_id
Description
Get the information of a single ethernet interface.
Return
Returns dict
Optional
optional arguments:
-h, --help show this help message and exit
networking ethernet-ifs list¶
Usage
usage: -c networking ethernet-ifs list [-h]
[-f {adaptive_table,csv,json,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--node NODE] [--marker MARKER]
[--limit LIMIT]
Description
Get the list of Ethernet interfaces
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--node NODE Filter by a node's UUID
--marker MARKER
--limit LIMIT
networking ipv4-ifs get¶
Usage
usage: -c networking ipv4-ifs get [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
ipv4_if_id
Description
Get information for a specific IPv4 interface
Return
Returns dict
Optional
optional arguments:
-h, --help show this help message and exit
networking ipv4-ifs list¶
Usage
usage: -c networking ipv4-ifs list [-h]
[-f {adaptive_table,csv,json,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--node NODE] [--name NAME] [--order ORDER]
[--sort-by SORT_BY] [--marker MARKER]
[--limit LIMIT]
Description
Get a list of all IPv4 interfaces.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--node NODE Filter by a node's UUID.
--name NAME Perform a query to get the member of a list that has this name.
--order ORDER The sorting order for get response.
--sort-by SORT_BY The field by which to sort.
--marker MARKER Specify the first entity that you want to retrieve.
--limit LIMIT Specify the number of entities that you want to retrieve.
networking link-ifs get¶
Usage
usage: -c networking link-ifs get [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
link_if_id
Description
Get the information of a single ethernet interface.
Return
Returns dict
Optional
optional arguments:
-h, --help show this help message and exit
networking link-ifs list¶
Usage
usage: -c networking link-ifs list [-h]
[-f {adaptive_table,csv,json,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--node NODE] [--mac MAC] [--marker MARKER]
[--limit LIMIT]
Description
Get the list of Link interfaces
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--node NODE Filter by a node's UUID
--mac MAC Filter by a link MAC address
--marker MARKER
--limit LIMIT
networking logical-nets create¶
Usage
usage: -c networking logical-nets create [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX] [--name NAME]
[--description DESCRIPTION]
subnet_uuid
Description
Create a new logical network.
Return
Returns dict
Optional
optional arguments:
-h, --help show this help message and exit
--name NAME The name of the logical net.
--description DESCRIPTION
A description of the logical net.
networking logical-nets get¶
Usage
usage: -c networking logical-nets get [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
logical_net_uuid
Description
Get the logical_net information
Return
Returns dict
Optional
optional arguments:
-h, --help show this help message and exit
networking logical-nets list¶
Usage
usage: -c networking logical-nets list [-h]
[-f {adaptive_table,csv,json,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--logical-net-uuid LOGICAL_NET_UUID]
[--subnet-uuid SUBNET_UUID]
[--name NAME]
Description
Returns a list of logical_nets
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--logical-net-uuid LOGICAL_NET_UUID
The id of the logical_net to get
--subnet-uuid SUBNET_UUID
Filter by subnet UUID
--name NAME Perform a query to get the member of a list that has this name
networking logical-nets remove¶
Usage
usage: -c networking logical-nets remove [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
logical_net_uuid
Description
Remove an logical-net.
Return
Returns dict
Optional
optional arguments:
-h, --help show this help message and exit
networking proxy-settings clear¶
Usage
usage: -c networking proxy-settings clear [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
Description
Clear the proxy settings. This causes the proxy to be disabled
Return
Returns dict
Optional
optional arguments:
-h, --help show this help message and exit
networking proxy-settings get¶
Usage
usage: -c networking proxy-settings get [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
Description
Returns dict
Return
Returns dict
Optional
optional arguments:
-h, --help show this help message and exit
networking proxy-settings update¶
Usage
usage: -c networking proxy-settings update [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--http-url HTTP_URL]
[--https-url HTTPS_URL]
[--no-proxy NO_PROXY]
[--enabled ENABLED]
Description
Update the cluster’s proxy settings
Return
Returns dict
Optional
optional arguments:
-h, --help show this help message and exit
--http-url HTTP_URL HTTP URL string of the proxy handling HTTP requests
--https-url HTTPS_URL
HTTP URL string of the proxy handling HTTPS requests
--no-proxy NO_PROXY List of ip addresses, subnets, and domain suffixes to exclude from proxy
--enabled ENABLED Boolean indicating if the proxy is enabled
networking proxy-settings-ifs get¶
Usage
usage: -c networking proxy-settings-ifs get [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>]
[--noindent] [--prefix PREFIX]
proxy_if_id
Description
Returns dict
Return
Returns dict
Optional
optional arguments:
-h, --help show this help message and exit
networking proxy-settings-ifs list¶
Usage
usage: -c networking proxy-settings-ifs list [-h]
[-f {adaptive_table,csv,json,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
Description
Returns list
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
networking routes create¶
Usage
usage: -c networking routes create [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
cidr next_hop
Description
Add a route.
Return
Returns dict
Optional
optional arguments:
-h, --help show this help message and exit
networking routes get¶
Usage
usage: -c networking routes get [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
route_id
Description
Get the details of a route.
Return
Returns dict
Optional
optional arguments:
-h, --help show this help message and exit
networking routes list¶
Usage
usage: -c networking routes list [-h]
[-f {adaptive_table,csv,json,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
Description
Get all the routes.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
networking routes remove¶
Usage
usage: -c networking routes remove [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
route_id
Description
Remove this route.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
networking subnets create¶
Usage
usage: -c networking subnets create [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX] [--name NAME]
[--description DESCRIPTION]
[--auto-create-logical-network AUTO_CREATE_LOGICAL_NETWORK]
vlan_uuid ip_info
Description
Create a new subnet.
Return
Returns dict
Optional
optional arguments:
-h, --help show this help message and exit
--name NAME The name of the subnet.
--description DESCRIPTION
A description of the subnet.
--auto-create-logical-network AUTO_CREATE_LOGICAL_NETWORK
Also create a new logical network over the new subnet
networking subnets get¶
Usage
usage: -c networking subnets get [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
subnet_uuid
Description
Get the subnet information
Return
Returns dict
Optional
optional arguments:
-h, --help show this help message and exit
networking subnets list¶
Usage
usage: -c networking subnets list [-h]
[-f {adaptive_table,csv,json,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--subnet-uuid SUBNET_UUID]
[--vlan-uuid VLAN_UUID] [--name NAME]
Description
Returns a list of subnets
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--subnet-uuid SUBNET_UUID
The id of the subnet to get
--vlan-uuid VLAN_UUID
Filter by VLAN UUID
--name NAME Perform a query to get the member of a list that has this name
networking subnets remove¶
Usage
usage: -c networking subnets remove [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
[--auto-delete-logical-network AUTO_DELETE_LOGICAL_NETWORK]
subnet_uuid
Description
Delete this subnet. All associated IP interfaces will also be deleted.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--auto-delete-logical-network AUTO_DELETE_LOGICAL_NETWORK
Automatically delete the upper logical network
networking traffic-ifs get¶
Usage
usage: -c networking traffic-ifs get [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
traffic_if_id
Description
Get information for a specific traffic interface
Return
Returns dict
Optional
optional arguments:
-h, --help show this help message and exit
networking traffic-ifs list¶
Usage
usage: -c networking traffic-ifs list [-h]
[-f {adaptive_table,csv,json,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--node NODE] [--name NAME]
[--order ORDER] [--sort-by SORT_BY]
[--marker MARKER] [--limit LIMIT]
Description
Get a list of all traffic interfaces.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--node NODE Filter by a node's UUID.
--name NAME Perform a query to get the member of a list that has this name.
--order ORDER The sorting order for get response.
--sort-by SORT_BY The field by which to sort.
--marker MARKER Specify the first entity that you want to retrieve.
--limit LIMIT Specify the number of entities that you want to retrieve.
networking traffic-types create¶
Usage
usage: -c networking traffic-types create [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX] [--name NAME]
[--description DESCRIPTION]
[--logical-net-uuid LOGICAL_NET_UUID]
traffic_type
Description
Create a dynamic traffic-type
Return
Returns dict: created traffic-type id
Optional
optional arguments:
-h, --help show this help message and exit
--name NAME The name of the traffic type
--description DESCRIPTION
The description of the traffic type
--logical-net-uuid LOGICAL_NET_UUID
UUID of the logical network to be used
networking traffic-types get¶
Usage
usage: -c networking traffic-types get [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
traffic_type_uuid
Description
Get the traffic type information
Return
Returns dict
Optional
optional arguments:
-h, --help show this help message and exit
networking traffic-types get-ips¶
Usage
usage: -c networking traffic-types get-ips [-h]
[-f {adaptive_table,csv,json,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
traffic_type
Description
Return all ips that are associated with a traffic type.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
networking traffic-types is-fully-configured¶
Usage
usage: -c networking traffic-types is-fully-configured [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>]
[--noindent]
[--prefix PREFIX]
traffic_type
Description
Indicate if traffic type is fully configured. It means that all local underlying are in sync with their global and the all locals are ready.
Return
Returns dict
Optional
optional arguments:
-h, --help show this help message and exit
networking traffic-types list¶
Usage
usage: -c networking traffic-types list [-h]
[-f {adaptive_table,csv,json,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--name NAME]
[--traffic-type TRAFFIC_TYPE]
Description
Get all the traffic types.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--name NAME Perform a query to get the member of a list that has this name
--traffic-type TRAFFIC_TYPE
Filter by the traffic type
networking traffic-types update¶
Usage
usage: -c networking traffic-types update [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX] [--name NAME]
[--description DESCRIPTION]
[--logical-net LOGICAL_NET]
traffic_type_uuid
Description
Update a given traffic type.
Return
Returns dict
Optional
optional arguments:
-h, --help show this help message and exit
--name NAME The name of the traffic type
--description DESCRIPTION
The description of the traffic type
--logical-net LOGICAL_NET
UUID of the logical network to be used
networking virtual-ips create¶
Usage
usage: -c networking virtual-ips create [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX] [--name NAME]
[--description DESCRIPTION]
vlan_uuid cidr gateway traffic_type
Description
Add a virtual_ip for specific vip_type
Return
Returns dict: virtual_ip id
Optional
optional arguments:
-h, --help show this help message and exit
--name NAME Name of the virtual ip (optional)
--description DESCRIPTION
Description of the virtual ip (optional)
networking virtual-ips get¶
Usage
usage: -c networking virtual-ips get [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
virtual_ip
Description
Get the details of a virtual IP.
Return
Returns dict: virtual ip entity
Optional
optional arguments:
-h, --help show this help message and exit
networking virtual-ips list¶
Usage
usage: -c networking virtual-ips list [-h]
[-f {adaptive_table,csv,json,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--vip-type VIP_TYPE]
Description
Get virtual ips.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--vip-type VIP_TYPE The type of the virtual ip to filter by.
networking virtual-ips remove¶
Usage
usage: -c networking virtual-ips remove [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
virtual_ip
Description
- positional arguments:
virtual_ip
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
networking vlan-ifs get¶
Usage
usage: -c networking vlan-ifs get [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
vlan_if_id
Description
Get information for a specific vlan interface
Return
Returns dict
Optional
optional arguments:
-h, --help show this help message and exit
networking vlan-ifs list¶
Usage
usage: -c networking vlan-ifs list [-h]
[-f {adaptive_table,csv,json,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--node NODE] [--name NAME] [--order ORDER]
[--sort-by SORT_BY] [--marker MARKER]
[--limit LIMIT]
Description
Get a list of all vlan interfaces.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--node NODE Filter by a node's UUID.
--name NAME Perform a query to get the member of a list that has this name.
--order ORDER The sorting order for get response.
--sort-by SORT_BY The field by which to sort.
--marker MARKER Specify the first entity that you want to retrieve.
--limit LIMIT Specify the number of entities that you want to retrieve.
networking vlans create¶
Usage
usage: -c networking vlans create [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
[--discovery-if DISCOVERY_IF] [--name NAME]
[--description DESCRIPTION]
[--discovery-vlan DISCOVERY_VLAN]
vlan_id
Description
Create a new cluster VLAN. Specify VID
Return
Returns dict
Optional
optional arguments:
-h, --help show this help message and exit
--discovery-if DISCOVERY_IF
UUID of the ethernet or bond interface to be used
--name NAME The name of the VLAN
--description DESCRIPTION
The description of the VLAN
--discovery-vlan DISCOVERY_VLAN
UUID of vlan to be used for discovery
networking vlans get¶
Usage
usage: -c networking vlans get [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
vlan_uuid
Description
Get the VLAN information
Return
Returns dict
Optional
optional arguments:
-h, --help show this help message and exit
networking vlans list¶
Usage
usage: -c networking vlans list [-h]
[-f {adaptive_table,csv,json,table,value,yaml}]
[-c COLUMN] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--name NAME] [--vlan-id VLAN_ID]
Description
Get all the cluster VLANs
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--name NAME Perform a query to get the member of a list that has this name
--vlan-id VLAN_ID Filter by the VLAN ID
networking vlans remove¶
Usage
usage: -c networking vlans remove [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
vlan_uuid
Description
Delete a given vlan. Deleting this resource will delete all the associated VLAN interfaces.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
networking vlans update¶
Usage
usage: -c networking vlans update [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX] [--name NAME]
[--description DESCRIPTION]
[--discovery-if DISCOVERY_IF]
[--remove-discovery-if]
vlan_uuid
Description
Update a given vlan.
Return
Returns dict
Optional
optional arguments:
-h, --help show this help message and exit
--name NAME The name of the VLAN
--description DESCRIPTION
The description of the VLAN
--discovery-if DISCOVERY_IF
The discovery if of the VLAN
--remove-discovery-if
Weather to remove discovery if of the VLAN
networking vn-group-ifs get¶
Usage
usage: -c networking vn-group-ifs get [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
vngroup_if_id
Description
Get information for a specific vngroup interface
Return
Returns dict
Optional
optional arguments:
-h, --help show this help message and exit
networking vn-group-ifs list¶
Usage
usage: -c networking vn-group-ifs list [-h]
[-f {adaptive_table,csv,json,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--node NODE] [--name NAME]
[--order ORDER] [--sort-by SORT_BY]
[--marker MARKER] [--limit LIMIT]
Description
Get a list of all vn_group interfaces.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--node NODE Filter by a node's UUID.
--name NAME Perform a query to get the member of a list that has this name.
--order ORDER The sorting order for get response.
--sort-by SORT_BY The field by which to sort.
--marker MARKER Specify the first entity that you want to retrieve.
--limit LIMIT Specify the number of entities that you want to retrieve.
networking vn-groups create¶
Usage
usage: -c networking vn-groups create [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
[--vlan-range VLAN_RANGE]
[--vni-range VNI_RANGE] [--name NAME]
[--description DESCRIPTION]
vn_type underlying
Description
- positional arguments:
vn_type underlying
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--vlan-range VLAN_RANGE
--vni-range VNI_RANGE
--name NAME
--description DESCRIPTION
networking vn-groups get¶
Usage
usage: -c networking vn-groups get [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
vn_group_id
Description
Get the VnGroup information
Return
Returns dict
Optional
optional arguments:
-h, --help show this help message and exit
networking vn-groups list¶
Usage
usage: -c networking vn-groups list [-h]
[-f {adaptive_table,csv,json,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--vn-type VN_TYPE]
Description
Get a list of all vn_group status.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--vn-type VN_TYPE Perform a query to get the member of a list that has this vn_type.
networking vn-groups remove¶
Usage
usage: -c networking vn-groups remove [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX] [--force]
vn_group_id
Description
Remove a VNGroup (Guest network pool) by its ID.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--force Force removal regardless of existing edge/guest networks on it
networking vn-groups update¶
Usage
usage: -c networking vn-groups update [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
[--vni-range VNI_RANGE]
[--vlan-range VLAN_RANGE] [--name NAME]
vn_group_id
Description
- positional arguments:
vn_group_id
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--vni-range VNI_RANGE
--vlan-range VLAN_RANGE
--name NAME
networking vn-type get-default-vn-type¶
Usage
usage: -c networking vn-type get-default-vn-type [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>]
[--noindent]
[--prefix PREFIX]
Description
- optional arguments:
- -h, --help
show this help message and exit
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
networking vn-type set-default-vn-type¶
Usage
usage: -c networking vn-type set-default-vn-type [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>]
[--noindent]
[--prefix PREFIX]
vn_type
Description
- positional arguments:
vn_type
Return
None
Optional
optional arguments:
-h, --help show this help message and exit