1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
|
.. -*- rst -*-
.. _security_group_default_rules:
===========================================================
Security group default rules (security-group-default-rules)
===========================================================
Lists, creates, shows information for, and deletes security group
default rules.
List security group default rules
=================================
.. rest_method:: GET /v2.0/default-security-group-rules
Lists a summary of all OpenStack Networking security group rules that are used
for every newly created Security Group.
The list provides the ID for each security group default rule.
.. include:: filtering-list.inc
Normal response codes: 200
Error response codes: 401
Request
-------
.. rest_parameters:: parameters.yaml
- remote_group_id: remote_group_id_template-query
- direction: direction-query
- protocol: protocol-query
- ethertype: ethertype-query
- port_range_max: port_range_max-query
- port_range_min: port_range_min-query
- remote_ip_prefix: remote_ip_prefix-query
- remote_address_group_id: remote_address_group_id-query
- used_in_default_sg: used_in_default_sg-query
- used_in_non_default_sg: used_in_non_default_sg-query
- id: id-query
- description: description-query
- sort_dir: sort_dir
- sort_key: security_group_rule-sort_key
- fields: fields
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- security_group_rules: security_group_rules
- remote_group_id: remote_group_id_template-query
- direction: direction
- protocol: protocol
- ethertype: ethertype
- port_range_max: port_range_max
- port_range_min: port_range_min
- remote_ip_prefix: remote_ip_prefix
- remote_address_group_id: remote_address_group_id
- used_in_default_sg: used_in_default_sg
- used_in_non_default_sg: used_in_non_default_sg
- id: default_security_group_rule-id
- description: description
Response Example
----------------
.. literalinclude:: samples/security-group-default-rules/security-group-default-rules-list-response.json
:language: javascript
Create security group default rule
==================================
.. rest_method:: POST /v2.0/default-security-group-rules
Creates an Openstack Networking security group rule template.
Normal response codes: 201
Error response codes: 400, 401, 404, 409
Request
-------
.. rest_parameters:: parameters.yaml
- default_security_group_rule: security_group_default_rule
- remote_group_id: remote_group_id-request
- direction: direction
- protocol: protocol-request
- ethertype: ethertype-request
- port_range_max: port_range_max-request
- port_range_min: port_range_min-request
- remote_ip_prefix: remote_ip_prefix-request
- remote_address_group_id: remote_address_group_id-request
- used_in_default_sg: used_in_default_sg
- used_in_non_default_sg: used_in_non_default_sg
- description: description-request
Request Example
---------------
.. literalinclude:: samples/security-group-default-rules/security-group-default-rule-create-request.json
:language: javascript
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- remote_group_id: remote_group_id
- direction: direction
- protocol: protocol
- ethertype: ethertype
- port_range_max: port_range_max
- port_range_min: port_range_min
- remote_ip_prefix: remote_ip_prefix
- remote_address_group_id: remote_address_group_id
- used_in_default_sg: used_in_default_sg
- used_in_non_default_sg: used_in_non_default_sg
- id: default_security_group_rule-id
- description: description
Response Example
----------------
.. literalinclude:: samples/security-group-default-rules/security-group-default-rule-create-response.json
:language: javascript
.. warning::
The security group rule template APIs do not validate the UUID of the resources
like ``remote address group id`` or ``remote group ID``. Any string can be
provided here, but please note that it will be used to create real security
group rules for projects, and if the UUID of a non-existing ``security
group`` or ``remote address group`` is used, it will cause errors during
creation of the security groups.
Show security group default rule
================================
.. rest_method:: GET /v2.0/default-security-group-rules/{default_security_group_rule_id}
Shows detailed information for a security group default rule.
The response body contains the following information about the
security group rule:
.. include:: filtering-show.inc
Normal response codes: 200
Error response codes: 401, 404
Request
-------
.. rest_parameters:: parameters.yaml
- default_security_group_rule_id: default_security_group_rule-id-path
- verbose: verbose
- fields: fields
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- default_security_group_rule: security_group_default_rule
- remote_group_id: remote_group_id
- direction: direction
- protocol: protocol
- ethertype: ethertype
- port_range_max: port_range_max
- port_range_min: port_range_min
- remote_ip_prefix: remote_ip_prefix
- remote_address_group_id: remote_address_group_id
- used_in_default_sg: used_in_default_sg
- used_in_non_default_sg: used_in_non_default_sg
- id: default_security_group_rule-id
- description: description
Response Example
----------------
.. literalinclude:: samples/security-group-default-rules/security-group-default-rule-show-response.json
:language: javascript
Delete security group default rule
==================================
.. rest_method:: DELETE /v2.0/default-security-group-rules/{default_security_group_rule_id}
Deletes an OpenStack Networking security group rule template.
Normal response codes: 204
Error response codes: 401, 404, 412
Request
-------
.. rest_parameters:: parameters.yaml
- default_security_group_rule_id: default_security_group_rule-id-path
Response
--------
There is no body content is returned on a successful DELETE request.
|
