← Back to branch summary

~yolanda.robla/nova/precise-security

« back to all changes in this revision

Viewing changes to doc/source/api_ext/ext_security_group.rst

  • Committer: Package Import Robot
  • Author(s): Chuck Short
  • Date: 2012-04-02 11:17:33 UTC
  • mto: (79.1.1 precise-proposed)
  • mto: This revision was merged to the branch mainline in revision 73.
  • Revision ID: package-import@ubuntu.com-20120402111733-jc0lg7anbrok67q7
Tags: upstream-2012.1~rc2
Import upstream version 2012.1~rc2

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/source/api_ext/ext_security_group.rst
1
 
About The Security Groups Extension
2
 
===================================
 
1
The Security Groups Extension
 
2
=================================================================
 
3
About this Extension
 
4
--------------------
3
5
The Security Groups extension lets you view, create, and remove security groups for instances plus set rules for security groups using the OpenStack Compute API 1.1.
4
6
 
5
7
.. Are there any pre-requisites prior to using it such as special hardware or configuration?
6
8
 
7
9
To obtain current information the extensions available to you, issue an EXTENSION query on the OpenStack system where it is installed, such as http://mycloud.com/v1.1/tenant/extensions.
8
10
 
9
 
Security Groups Extension Overview
10
 
----------------------------------
 
11
Extension Overview
 
12
~~~~~~~~~~~~~~~~~~
11
13
 
12
14
Name
13
15
        Security Groups
40
42
        This extension enables creation and listing of security groups.
41
43
 
42
44
Sample Query Responses
43
 
----------------------
 
45
~~~~~~~~~~~~~~~~~~~~~~
44
46
 
45
47
As shown below, responses to an EXTENSION query in XML or JSON provide basic information about the extension. 
46
48
 
59
61
 
60
62
    {"extensions": [{"updated": "2011-07-21T00:00:00+00:00", "name": "SecurityGroups", "links": [], "namespace": "http://docs.openstack.org/ext/securitygroups/api/v1.1", "alias": "security_groups", "description": "Security group support"}]}
61
63
 
 
64
 
62
65
Document Change History
63
 
-----------------------
 
66
~~~~~~~~~~~~~~~~~~~~~~~
64
67
 
65
68
============= =====================================
66
69
Revision Date Summary of Changes
67
70
2011-09-16    Initial draft
 
71
2012-03-30    Reformat of content
68
72
============= =====================================
69
73
 
70
74
 
71
75
Summary of Changes
72
 
==================
 
76
------------------
73
77
This extension to the Compute API allows you to create, update, and delete security groups. 
74
78
 
75
 
To support these new actions, the extension also issues new (faults, headers, resources, states, you name it.)
 
79
This support is provided by the addition of new actions.
76
80
 
77
81
New Actions
78
 
-----------
 
82
~~~~~~~~~~~
79
83
os-security-group
80
84
 
81
85
os-security-group-rules
82
86
 
83
 
 
84
87
Include the response codes, transitions if applicable, and XML and JSON examples.
85
88
 
86
89
New Faults
87
 
----------
88
 
 
 
90
~~~~~~~~~~
89
91
None
90
92
 
91
93
New Headers
92
 
-----------
93
 
 
 
94
~~~~~~~~~~~
94
95
None
95
96
 
96
97
New Resources
97
 
-------------
98
 
 
 
98
~~~~~~~~~~~~~
99
99
None
100
100
 
101
101
New States
102
 
----------
103
 
 
 
102
~~~~~~~~~~
104
103
None
105
104
 
106
105
Changes to the Cloud Servers Specification
107
 
------------------------------------------
108
 
 
109
 
List the specific changes to the API. For example: 
110
 
 
111
 
In section 4.1.1 (List Servers) of the Cloud Servers Specification: Examples 4.1 and 4.2 should be replaced with Example 2.7 and Example 2.8 below. 
 
106
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
107
 
 
108
List the specific changes to the API. For example:
 
109
 
 
110
In section 4.1.1 (List Servers) of the Cloud Servers Specification: Examples 4.1 and 4.2 should be replaced with Example 2.7 and Example 2.8 below.
112
111
 
113
112
Provide examples in XML and JSON