Showing security group default rule details

GET /v2.0/default-security-group-rules/{default_security_group_rule_id}

Shows the details of a security group default rule.

Source: https://docs.openstack.org/api-ref/network/v2/index.html#show-security-group-default-rule

Request

Parameters

Name	In	Type	Description
security_group_rule_id	path	string	The ID of the security group rule.
verbose (Optional)	query	boolean	Show detailed information.
fields (Optional)	query	string	The fields that you want the server to return. If no fields query parameter is specified, the networking API returns all attributes allowed by the policy settings. By using the fields parameter, the API returns only the requested set of attributes. The fields parameter can be specified multiple times. For example, if you specify fields=id&fields=name in the request URL, only the id and name attributes will be returned.

Example

# curl -ks -H 'Content-Type: application/json' -H 'X-Auth-Token: gAAAAA<...>' \
https://<node_IP_addr>:9696/v2.0/default-security-group-rules/eb8ad926-f5c9-4371-b35f-e69563b695ac

Response

Parameters

Name	In	Type	Description
default_security_group_rule	body	object	A default_security_group_rule object.
id	body	string	The ID of the security group rule.
description	body	string	A human-readable description for the resource.
remote_group_id	body	string	The remote group UUID to associate with this security group rule.
remote_address_group_id	body	string	The remote address group UUID that is associated with this security group rule.
direction	body	string	Ingress or egress, which is the direction in which the security group rule is applied.
protocol	body	string	The IP protocol represented by a string, an integer, or null. The string any (or integer 0) means all IP protocols.
ethertype	body	string	Ethertype: IPv4 or IPv6.
port_range_max	body	integer	The maximum port number in the range that is matched by the security group rule.
port_range_min	body	integer	The minimum port number in the range that is matched by the security group rule.
remote_ip_prefix	body	string	The remote IP prefix that is matched by this security group rule.
used_in_default_sg	body	boolean	Indicates whether this security group rule template will be used in the default security group created automatically for each new project.
used_in_non_default_sg	body	boolean	Indicates whether this security group rule template will be used in custom security groups created by a project user.

Status codes

Success

Code	Reason
200 - OK	Request was successful.

Error

Code	Reason
401 - Unauthorized	User must authenticate before making a request.
404 - Not Found	The requested resource could not be found.

Example

{
  "default_security_group_rule": {
    "id": "eb8ad926-f5c9-4371-b35f-e69563b695ac",
    "ethertype": "IPv4",
    "direction": "ingress",
    "protocol": "tcp",
    "port_range_min": 80,
    "port_range_max": 80,
    "remote_ip_prefix": null,
    "remote_address_group_id": null,
    "remote_group_id": null,
    "description": "",
    "used_in_default_sg": true,
    "used_in_non_default_sg": true
  }
}