Apache CloudStack 4.20.0.0 Root Admin API Reference

listSecurityGroups

Lists security groups

Request parameters

Parameter Name	Description	Required
account	list resources by account. Must be used with the domainId parameter.	false
domainid	list only resources belonging to the domain specified	false
id	list the security group by the id provided	false
isrecursive	defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.	false
keyword	List by keyword	false
listall	If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.	false
page		false
pagesize		false
projectid	list objects by project; if projectid=-1 lists All VMs	false
securitygroupname	lists security groups by name	false
tags	List resources by tags (key/value pairs)	false
virtualmachineid	lists security groups by virtual machine id	false

Response Tags

Response Name	Description
id	the ID of the security group
account	the account owning the security group
description	the description of the security group
domain	the domain name of the security group
domainid	the domain ID of the security group
domainpath	path of the Domain the security group belongs to
name	the name of the security group
project	the project name of the group
projectid	the project id of the group
virtualmachinecount	the number of virtualmachines associated with this securitygroup
virtualmachineids	the list of virtualmachine ids associated with this securitygroup
*egressrule()**	the list of egress rules associated with the security group
account	account owning the security group rule
cidr	the CIDR notation for the base IP address of the security group rule
endport	the ending IP of the security group rule
icmpcode	the code for the ICMP message response
icmptype	the type of the ICMP message response
protocol	the protocol of the security group rule
ruleid	the id of the security group rule
securitygroupname	security group name
startport	the starting IP of the security group rule
*tags()**	the list of resource tags associated with the rule
account	the account associated with the tag
customer	customer associated with the tag
domain	the domain associated with the tag
domainid	the ID of the domain associated with the tag
domainpath	path of the Domain associated with the tag
key	tag key name
project	the project name where tag belongs to
projectid	the project id the tag belongs to
resourceid	id of the resource
resourcetype	resource type
value	tag value
*ingressrule()**	the list of ingress rules associated with the security group
account	account owning the security group rule
cidr	the CIDR notation for the base IP address of the security group rule
endport	the ending IP of the security group rule
icmpcode	the code for the ICMP message response
icmptype	the type of the ICMP message response
protocol	the protocol of the security group rule
ruleid	the id of the security group rule
securitygroupname	security group name
startport	the starting IP of the security group rule
*tags()**	the list of resource tags associated with the rule
account	the account associated with the tag
customer	customer associated with the tag
domain	the domain associated with the tag
domainid	the ID of the domain associated with the tag
domainpath	path of the Domain associated with the tag
key	tag key name
project	the project name where tag belongs to
projectid	the project id the tag belongs to
resourceid	id of the resource
resourcetype	resource type
value	tag value
*tags()**	the list of resource tags associated with the rule
account	the account associated with the tag
customer	customer associated with the tag
domain	the domain associated with the tag
domainid	the ID of the domain associated with the tag
domainpath	path of the Domain associated with the tag
key	tag key name
project	the project name where tag belongs to
projectid	the project id the tag belongs to
resourceid	id of the resource
resourcetype	resource type
value	tag value
jobid	the ID of the latest async job acting on this object
jobstatus	the current status of the latest async job acting on this object

Copyright © 2015 The Apache Software Foundation, Licensed under the Apache License, Version 2.0.
Apache, CloudStack, Apache CloudStack, the Apache CloudStack logo, the CloudMonkey logo and the Apache feather logo are trademarks of The Apache Software Foundation.