1Network API
2===========
3
4For details on how to use network, see :doc:`/user/guides/network`
5
6.. automodule:: openstack.network.v2._proxy
7
8The Network Class
9-----------------
10
11The network high-level interface is available through the ``network``
12member of a :class:`~openstack.connection.Connection` object.  The
13``network`` member will only be added if the service is detected.
14
15Network Operations
16^^^^^^^^^^^^^^^^^^
17
18.. autoclass:: openstack.network.v2._proxy.Proxy
19  :noindex:
20  :members: create_network, update_network, delete_network, get_network,
21            find_network, networks, get_network_ip_availability,
22            find_network_ip_availability, network_ip_availabilities,
23            add_dhcp_agent_to_network, remove_dhcp_agent_from_network,
24            dhcp_agent_hosting_networks,
25
26Port Operations
27^^^^^^^^^^^^^^^
28
29.. autoclass:: openstack.network.v2._proxy.Proxy
30  :noindex:
31  :members: create_port, create_ports, update_port, delete_port, get_port,
32            find_port, ports, add_ip_to_port, remove_ip_from_port
33
34Router Operations
35^^^^^^^^^^^^^^^^^
36
37.. autoclass:: openstack.network.v2._proxy.Proxy
38  :noindex:
39  :members: create_router, update_router, delete_router, get_router,
40            find_router, routers,
41            add_gateway_to_router, remove_gateway_from_router,
42            add_interface_to_router, remove_interface_from_router,
43            add_extra_routes_to_router, remove_extra_routes_from_router,
44            create_conntrack_helper, update_conntrack_helper,
45            delete_conntrack_helper, get_conntrack_helper, conntrack_helpers
46
47
48
49Floating IP Operations
50^^^^^^^^^^^^^^^^^^^^^^
51
52.. autoclass:: openstack.network.v2._proxy.Proxy
53  :noindex:
54  :members: create_ip, update_ip, delete_ip, get_ip, find_ip,
55            find_available_ip, ips
56
57Pool Operations
58^^^^^^^^^^^^^^^
59
60.. autoclass:: openstack.network.v2._proxy.Proxy
61  :noindex:
62  :members: create_pool, update_pool, delete_pool, get_pool, find_pool, pools,
63            create_pool_member, update_pool_member, delete_pool_member,
64            get_pool_member, find_pool_member, pool_members
65
66Auto Allocated Topology Operations
67^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
68
69.. autoclass:: openstack.network.v2._proxy.Proxy
70  :noindex:
71  :members: delete_auto_allocated_topology, get_auto_allocated_topology,
72            validate_auto_allocated_topology
73
74Security Group Operations
75^^^^^^^^^^^^^^^^^^^^^^^^^
76
77.. autoclass:: openstack.network.v2._proxy.Proxy
78  :noindex:
79  :members: create_security_group, update_security_group,
80            delete_security_group, get_security_group,
81            get_security_group_rule, find_security_group,
82            find_security_group_rule, security_group_rules,
83            security_groups, create_security_group_rule,
84            create_security_group_rules, delete_security_group_rule
85
86Availability Zone Operations
87^^^^^^^^^^^^^^^^^^^^^^^^^^^^
88
89.. autoclass:: openstack.network.v2._proxy.Proxy
90  :noindex:
91  :members: availability_zones
92
93Address Scope Operations
94^^^^^^^^^^^^^^^^^^^^^^^^
95
96.. autoclass:: openstack.network.v2._proxy.Proxy
97  :noindex:
98  :members: create_address_scope, update_address_scope, delete_address_scope,
99            get_address_scope, find_address_scope, address_scopes
100
101Quota Operations
102^^^^^^^^^^^^^^^^
103
104.. autoclass:: openstack.network.v2._proxy.Proxy
105  :noindex:
106  :members: update_quota, delete_quota, get_quota, get_quota_default, quotas
107
108QoS Operations
109^^^^^^^^^^^^^^
110
111.. autoclass:: openstack.network.v2._proxy.Proxy
112  :noindex:
113  :members: create_qos_policy, update_qos_policy, delete_qos_policy,
114            get_qos_policy, find_qos_policy, qos_policies, get_qos_rule_type,
115            find_qos_rule_type, qos_rule_types,
116            create_qos_minimum_bandwidth_rule,
117            update_qos_minimum_bandwidth_rule,
118            delete_qos_minimum_bandwidth_rule,
119            get_qos_minimum_bandwidth_rule,
120            find_qos_minimum_bandwidth_rule,
121            qos_minimum_bandwidth_rules,
122            create_qos_bandwidth_limit_rule,
123            update_qos_bandwidth_limit_rule,
124            delete_qos_bandwidth_limit_rule,
125            get_qos_bandwidth_limit_rule, find_qos_bandwidth_limit_rule,
126            qos_bandwidth_limit_rules,
127            create_qos_dscp_marking_rule, update_qos_dscp_marking_rule,
128            delete_qos_dscp_marking_rule, get_qos_dscp_marking_rule,
129            find_qos_dscp_marking_rule, qos_dscp_marking_rules
130
131Agent Operations
132^^^^^^^^^^^^^^^^
133
134.. autoclass:: openstack.network.v2._proxy.Proxy
135  :noindex:
136  :members: delete_agent, update_agent, get_agent, agents,
137            agent_hosted_routers, routers_hosting_l3_agents,
138            network_hosting_dhcp_agents, add_router_to_agent,
139            remove_router_from_agent
140
141RBAC Operations
142^^^^^^^^^^^^^^^
143
144.. autoclass:: openstack.network.v2._proxy.Proxy
145  :noindex:
146  :members: create_rbac_policy, update_rbac_policy, delete_rbac_policy,
147            get_rbac_policy, find_rbac_policy, rbac_policies
148
149Listener Operations
150^^^^^^^^^^^^^^^^^^^
151
152.. autoclass:: openstack.network.v2._proxy.Proxy
153  :noindex:
154  :members: create_listener, update_listener, delete_listener,
155            get_listener, find_listener, listeners
156
157Subnet Operations
158^^^^^^^^^^^^^^^^^
159
160.. autoclass:: openstack.network.v2._proxy.Proxy
161  :noindex:
162  :members: create_subnet, update_subnet, delete_subnet, get_subnet,
163            get_subnet_ports, find_subnet, subnets, create_subnet_pool,
164            update_subnet_pool, delete_subnet_pool, get_subnet_pool,
165            find_subnet_pool, subnet_pools
166
167Load Balancer Operations
168^^^^^^^^^^^^^^^^^^^^^^^^
169
170.. autoclass:: openstack.network.v2._proxy.Proxy
171  :noindex:
172  :members: create_load_balancer, update_load_balancer, delete_load_balancer,
173            get_load_balancer, find_load_balancer, load_balancers
174
175Health Monitor Operations
176^^^^^^^^^^^^^^^^^^^^^^^^^
177
178.. autoclass:: openstack.network.v2._proxy.Proxy
179  :noindex:
180  :members: create_health_monitor, update_health_monitor,
181            delete_health_monitor, get_health_monitor, find_health_monitor,
182            health_monitors
183
184Metering Label Operations
185^^^^^^^^^^^^^^^^^^^^^^^^^
186
187.. autoclass:: openstack.network.v2._proxy.Proxy
188  :noindex:
189  :members: create_metering_label, update_metering_label,
190            delete_metering_label, get_metering_label, find_metering_label,
191            metering_labels, create_metering_label_rule,
192            update_metering_label_rule, delete_metering_label_rule,
193            get_metering_label_rule, find_metering_label_rule,
194            metering_label_rules
195
196Segment Operations
197^^^^^^^^^^^^^^^^^^
198
199.. autoclass:: openstack.network.v2._proxy.Proxy
200  :noindex:
201  :members: create_segment, update_segment, delete_segment, get_segment,
202            find_segment, segments
203
204Flavor Operations
205^^^^^^^^^^^^^^^^^
206
207.. autoclass:: openstack.network.v2._proxy.Proxy
208  :noindex:
209  :members: create_flavor, update_flavor, delete_flavor, get_flavor,
210            find_flavor, flavors
211
212Service Profile Operations
213^^^^^^^^^^^^^^^^^^^^^^^^^^
214
215.. autoclass:: openstack.network.v2._proxy.Proxy
216  :noindex:
217  :members: create_service_profile, update_service_profile,
218            delete_service_profile, get_service_profile, find_service_profile,
219            service_profiles, associate_flavor_with_service_profile,
220            disassociate_flavor_from_service_profile
221
222Tag Operations
223^^^^^^^^^^^^^^
224
225.. autoclass:: openstack.network.v2._proxy.Proxy
226  :noindex:
227  :members: set_tags
228
229VPN Operations
230^^^^^^^^^^^^^^
231
232.. autoclass:: openstack.network.v2._proxy.Proxy
233  :noindex:
234  :members: create_vpn_service, update_vpn_service, delete_vpn_service,
235            get_vpn_service, find_vpn_service, vpn_services
236
237IPSecSiteConnection Operations
238^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
239
240.. autoclass:: openstack.network.v2._proxy.Proxy
241  :noindex:
242  :members: create_vpn_ipsec_site_connection, update_vpn_ipsec_site_connection,
243            delete_vpn_ipsec_site_connection, get_vpn_ipsec_site_connection,
244            find_vpn_ipsec_site_connection, vpn_ipsec_site_connections
245
246Extension Operations
247^^^^^^^^^^^^^^^^^^^^
248
249.. autoclass:: openstack.network.v2._proxy.Proxy
250  :noindex:
251  :members: find_extension, extensions
252
253Service Provider Operations
254^^^^^^^^^^^^^^^^^^^^^^^^^^^
255
256.. autoclass:: openstack.network.v2._proxy.Proxy
257  :noindex:
258  :members: service_providers
259