Security Groups¶
securitygroup list¶
List security groups.
securitygroup list [OPTIONS]
Options
- --sortby <sortby>¶
Column to sort by
- Options
id | name | description
- -l, --limit <limit>¶
How many results to get in one api call, default is 100
- Default
100
securitygroup detail¶
Get details about a security group.
securitygroup detail [OPTIONS] IDENTIFIER
Arguments
- IDENTIFIER¶
Required argument
securitygroup create¶
Create a security group.
securitygroup create [OPTIONS]
Options
- -n, --name <name>¶
The name of the security group
- -d, --description <description>¶
The description of the security group
securitygroup edit¶
Edit details of a security group.
securitygroup edit [OPTIONS] GROUP_ID
Options
- -n, --name <name>¶
The name of the security group
- -d, --description <description>¶
The description of the security group
Arguments
- GROUP_ID¶
Required argument
securitygroup delete¶
Deletes the given security group
securitygroup delete [OPTIONS] SECURITYGROUP_ID
Arguments
- SECURITYGROUP_ID¶
Required argument
securitygroup rule-list¶
List security group rules.
securitygroup rule-list [OPTIONS] SECURITYGROUP_ID
Options
- --sortby <sortby>¶
Column to sort by
- Options
id | remoteIp | remoteGroupId | direction | ethertype | portRangeMin | portRangeMax | protocol | createDate | modifyDate
Arguments
- SECURITYGROUP_ID¶
Required argument
securitygroup rule-add¶
Add a security group rule to a security group.
securitygroup rule-add [OPTIONS] SECURITYGROUP_ID
Options
- -r, --remote-ip <remote_ip>¶
The remote IP/CIDR to enforce
- -s, --remote-group <remote_group>¶
The ID of the remote security group to enforce
- -d, --direction <direction>¶
The direction of traffic to enforce (ingress, egress)
- -e, --ethertype <ethertype>¶
The ethertype (IPv4 or IPv6) to enforce
- -M, --port-max <port_max>¶
The upper port bound to enforce. When the protocol is ICMP, this specifies the ICMP code to permit
- -m, --port-min <port_min>¶
The lower port bound to enforce. When the protocol is ICMP, this specifies the ICMP type to permit
- -p, --protocol <protocol>¶
The protocol (icmp, tcp, udp) to enforce
Arguments
- SECURITYGROUP_ID¶
Required argument
securitygroup rule-edit¶
Edit a security group rule in a security group.
securitygroup rule-edit [OPTIONS] SECURITYGROUP_ID RULE_ID
Options
- -r, --remote-ip <remote_ip>¶
The remote IP/CIDR to enforce
- -s, --remote-group <remote_group>¶
The ID of the remote security group to enforce
- -d, --direction <direction>¶
The direction of traffic to enforce
- -e, --ethertype <ethertype>¶
The ethertype (IPv4 or IPv6) to enforce
- -M, --port-max <port_max>¶
The upper port bound to enforce
- -m, --port-min <port_min>¶
The lower port bound to enforce
- -p, --protocol <protocol>¶
The protocol (icmp, tcp, udp) to enforce
Arguments
- SECURITYGROUP_ID¶
Required argument
- RULE_ID¶
Required argument
securitygroup rule-remove¶
Remove a rule from a security group.
securitygroup rule-remove [OPTIONS] SECURITYGROUP_ID RULE_ID
Arguments
- SECURITYGROUP_ID¶
Required argument
- RULE_ID¶
Required argument
securitygroup interface-list¶
List interfaces associated with security groups.
securitygroup interface-list [OPTIONS] SECURITYGROUP_ID
Options
- --sortby <sortby>¶
Column to sort by
- Options
networkComponentId | virtualServerId | hostname | interface | ipAddress
Arguments
- SECURITYGROUP_ID¶
Required argument
securitygroup interface-add¶
Attach an interface to a security group.
securitygroup interface-add [OPTIONS] SECURITYGROUP_ID
Options
- -n, --network-component <network_component>¶
The network component to associate with the security group
- -s, --server <server>¶
The server ID to associate with the security group
- -i, --interface <interface>¶
The interface of the server to associate (public/private)
Arguments
- SECURITYGROUP_ID¶
Required argument
securitygroup interface-remove¶
Detach an interface from a security group.
securitygroup interface-remove [OPTIONS] SECURITYGROUP_ID
Options
- -n, --network-component <network_component>¶
The network component to remove from with the security group
- -s, --server <server>¶
The server ID to remove from the security group
- -i, --interface <interface>¶
The interface of the server to remove (public/private)
Arguments
- SECURITYGROUP_ID¶
Required argument
securitygroup event-log¶
Search for event logs by request id
securitygroup event-log [OPTIONS] REQUEST_ID
Arguments
- REQUEST_ID¶
Required argument