~0x44/nova/extdoc

« back to all changes in this revision

Viewing changes to nova/api/openstack/contrib/doc/ext_multinic.rst

  • Committer: Anne Gentle
  • Date: 2011-09-15 03:07:06 UTC
  • Revision ID: anne@openstack.org-20110915030706-oukxthnhst8xswnf
Adds extension documents for extensions in /contrib/doc

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
About This Extension
 
2
====================
 
3
This extension enables addFixedIp and removeFixedIp actions on servers. It is used with the OpenStack Compute 1.1 API to add or remove fixed IP addresses on named instances. 
 
4
 
 
5
To use this extension, you must have configured Compute with more than one Network Interface Card.
 
6
 
 
7
.. Are there any pre-requisites prior to using it such as special hardware or configuration?
 
8
 
 
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/extension.
 
10
 
 
11
Extension Overview
 
12
------------------
 
13
 
 
14
Name
 
15
        Multinic
 
16
        
 
17
Namespace
 
18
        http://docs.openstack.org/ext/multinic/api/v1.1
 
19
 
 
20
Alias
 
21
        OPS-MLT
 
22
        
 
23
Contact
 
24
        Name <kevin.mitchell@rackspace.com>
 
25
        
 
26
Status
 
27
        Alpha
 
28
        
 
29
Extension Version
 
30
        v1.0 (2011-09-14)
 
31
 
 
32
Dependencies
 
33
        Compute API 1.1
 
34
        
 
35
Doc Link (PDF)
 
36
        http://
 
37
        
 
38
Doc Link (WADL)
 
39
        http://
 
40
        
 
41
Short Description
 
42
        This extension enables the assignment and removal of fixed IP addresses on virtual servers running in an OpenStack cloud.
 
43
 
 
44
Sample Query Responses
 
45
----------------------
 
46
 
 
47
As shown below, responses to an EXTENSION query in XML or JSON provide basic information about the extension. 
 
48
 
 
49
Extension Query Response: XML::
 
50
 
 
51
 
 
52
Extension Query Response: JSON::
 
53
 
 
54
 
 
55
Document Change History
 
56
-----------------------
 
57
 
 
58
============= =====================================
 
59
Revision Date Summary of Changes
 
60
2011-09-14    Initial draft
 
61
============= =====================================
 
62
 
 
63
 
 
64
Summary of Changes
 
65
==================
 
66
This extension to the Compute API allows addition and removal of fixed IP addresses to instances.
 
67
 
 
68
To support these new actions, the extension also issues new (faults, headers, resources, states, you name it.)
 
69
 
 
70
New Action
 
71
----------
 
72
This extension uses POST to add or remove fixed IP addresses to instances.
 
73
 
 
74
Normal Response Code: 202
 
75
 
 
76
Enter "None" if there are no changes to the sections below. 
 
77
 
 
78
Include the response codes, transitions if applicable, and XML and JSON examples.
 
79
 
 
80
New Faults
 
81
----------
 
82
 
 
83
New Headers
 
84
-----------
 
85
 
 
86
New Resources
 
87
-------------
 
88
 
 
89
New States
 
90
----------
 
91
 
 
92
Changes to the Cloud Servers Specification
 
93
------------------------------------------
 
94
 
 
95
List the specific changes to the API. For example: 
 
96
 
 
97
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. 
 
98
 
 
99
Provide examples in XML and JSON
 
 
b'\\ No newline at end of file'