openstack/openstacksdk
Code Issues Proposed changes

Update docs to work with newer Sphinx

Browse Source 
Change-Id: Ic15793329aa1f6027465eb362fcd0a0471d7b396
This commit is contained in:
Artem Goncharov
2020-04-21 15:35:27 +02:00
parent a53edeeaac
commit f132edff2a
19 changed files with 417 additions and 930 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
doc/source/user/proxies/accelerator.rst
View File

@@ -15,37 +15,29 @@ Device Operations
^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.accelerator.v2._proxy.Proxy
.. automethod:: openstack.accelerator.v2._proxy.Proxy.get_device
.. automethod:: openstack.accelerator.v2._proxy.Proxy.devices
:noindex:
:members: devices, get_device
Deployable Operations
^^^^^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.accelerator.v2._proxy.Proxy
.. automethod:: openstack.accelerator.v2._proxy.Proxy.update_deployable
.. automethod:: openstack.accelerator.v2._proxy.Proxy.get_deployable
.. automethod:: openstack.accelerator.v2._proxy.Proxy.deployables
:noindex:
:members: deployables, get_deployable, update_deployable
Device Profile Operations
^^^^^^^^^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.accelerator.v2._proxy.Proxy
.. automethod:: openstack.accelerator.v2._proxy.Proxy.create_device_profile
.. automethod:: openstack.accelerator.v2._proxy.Proxy.delete_device_profile
.. automethod:: openstack.accelerator.v2._proxy.Proxy.get_device_profile
.. automethod:: openstack.accelerator.v2._proxy.Proxy.device_profiles
:noindex:
:members: device_profiles, get_device_profile,
create_device_profile, delete_device_profile
Accelerator Request Operations
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.accelerator.v2._proxy.Proxy
.. automethod:: openstack.accelerator.v2._proxy.Proxy.create_accelerator_request
.. automethod:: openstack.accelerator.v2._proxy.Proxy.delete_accelerator_request
.. automethod:: openstack.accelerator.v2._proxy.Proxy.get_accelerator_request
.. automethod:: openstack.accelerator.v2._proxy.Proxy.accelerator_requests
.. automethod:: openstack.accelerator.v2._proxy.Proxy.update_accelerator_request
:noindex:
:members: accelerator_requests, get_accelerator_request,
create_accelerator_request, delete_accelerator_request,
update_accelerator_request

76
doc/source/user/proxies/baremetal.rst
View File

@@ -15,84 +15,51 @@ The ``baremetal`` member will only be added if the service is detected.
Node Operations
^^^^^^^^^^^^^^^
.. autoclass:: openstack.baremetal.v1._proxy.Proxy
.. automethod:: openstack.baremetal.v1._proxy.Proxy.create_node
.. automethod:: openstack.baremetal.v1._proxy.Proxy.update_node
.. automethod:: openstack.baremetal.v1._proxy.Proxy.patch_node
.. automethod:: openstack.baremetal.v1._proxy.Proxy.delete_node
.. automethod:: openstack.baremetal.v1._proxy.Proxy.get_node
.. automethod:: openstack.baremetal.v1._proxy.Proxy.find_node
.. automethod:: openstack.baremetal.v1._proxy.Proxy.nodes
.. automethod:: openstack.baremetal.v1._proxy.Proxy.set_node_power_state
.. automethod:: openstack.baremetal.v1._proxy.Proxy.set_node_provision_state
.. automethod:: openstack.baremetal.v1._proxy.Proxy.wait_for_nodes_provision_state
.. automethod:: openstack.baremetal.v1._proxy.Proxy.wait_for_node_reservation
.. automethod:: openstack.baremetal.v1._proxy.Proxy.validate_node
.. automethod:: openstack.baremetal.v1._proxy.Proxy.set_node_maintenance
.. automethod:: openstack.baremetal.v1._proxy.Proxy.unset_node_maintenance
:noindex:
:members: nodes, find_node, get_node, create_node, update_node, patch_node, delete_node,
validate_node, set_node_power_state, set_node_provision_state,
wait_for_nodes_provision_state, wait_for_node_reservation,
set_node_maintenance, unset_node_maintenance
Port Operations
^^^^^^^^^^^^^^^
.. autoclass:: openstack.baremetal.v1._proxy.Proxy
.. automethod:: openstack.baremetal.v1._proxy.Proxy.create_port
.. automethod:: openstack.baremetal.v1._proxy.Proxy.update_port
.. automethod:: openstack.baremetal.v1._proxy.Proxy.patch_port
.. automethod:: openstack.baremetal.v1._proxy.Proxy.delete_port
.. automethod:: openstack.baremetal.v1._proxy.Proxy.get_port
.. automethod:: openstack.baremetal.v1._proxy.Proxy.find_port
.. automethod:: openstack.baremetal.v1._proxy.Proxy.ports
:noindex:
:members: ports, find_port, get_port, create_port, update_port, delete_port, patch_port
Port Group Operations
^^^^^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.baremetal.v1._proxy.Proxy
.. automethod:: openstack.baremetal.v1._proxy.Proxy.create_port_group
.. automethod:: openstack.baremetal.v1._proxy.Proxy.update_port_group
.. automethod:: openstack.baremetal.v1._proxy.Proxy.patch_port_group
.. automethod:: openstack.baremetal.v1._proxy.Proxy.delete_port_group
.. automethod:: openstack.baremetal.v1._proxy.Proxy.get_port_group
.. automethod:: openstack.baremetal.v1._proxy.Proxy.find_port_group
.. automethod:: openstack.baremetal.v1._proxy.Proxy.port_groups
:noindex:
:members: port_groups, find_port_group, get_port_group,
create_port_group, update_port_group, delete_port_group, patch_port_group
Driver Operations
^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.baremetal.v1._proxy.Proxy
.. automethod:: openstack.baremetal.v1._proxy.Proxy.drivers
.. automethod:: openstack.baremetal.v1._proxy.Proxy.get_driver
:noindex:
:members: drivers, get_driver
Chassis Operations
^^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.baremetal.v1._proxy.Proxy
.. automethod:: openstack.baremetal.v1._proxy.Proxy.create_chassis
.. automethod:: openstack.baremetal.v1._proxy.Proxy.update_chassis
.. automethod:: openstack.baremetal.v1._proxy.Proxy.patch_chassis
.. automethod:: openstack.baremetal.v1._proxy.Proxy.delete_chassis
.. automethod:: openstack.baremetal.v1._proxy.Proxy.get_chassis
.. automethod:: openstack.baremetal.v1._proxy.Proxy.find_chassis
.. automethod:: openstack.baremetal.v1._proxy.Proxy.chassis
:noindex:
:members: chassis, find_chassis, get_chassis,
create_chassis, update_chassis, patch_chassis, delete_chassis
VIF Operations
^^^^^^^^^^^^^^
.. autoclass:: openstack.baremetal.v1._proxy.Proxy
.. automethod:: openstack.baremetal.v1._proxy.Proxy.attach_vif_to_node
.. automethod:: openstack.baremetal.v1._proxy.Proxy.detach_vif_from_node
.. automethod:: openstack.baremetal.v1._proxy.Proxy.list_node_vifs
:noindex:
:members: list_node_vifs, attach_vif_to_node, detach_vif_from_node
Allocation Operations
^^^^^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.baremetal.v1._proxy.Proxy
.. automethod:: openstack.baremetal.v1._proxy.Proxy.create_allocation
.. automethod:: openstack.baremetal.v1._proxy.Proxy.update_allocation
.. automethod:: openstack.baremetal.v1._proxy.Proxy.patch_allocation
.. automethod:: openstack.baremetal.v1._proxy.Proxy.delete_allocation
.. automethod:: openstack.baremetal.v1._proxy.Proxy.get_allocation
.. automethod:: openstack.baremetal.v1._proxy.Proxy.allocations
.. automethod:: openstack.baremetal.v1._proxy.Proxy.wait_for_allocation
:noindex:
:members: allocations, get_allocation, create_allocation,
update_allocation, patch_allocation, delete_allocation,
wait_for_allocation
Utilities
---------
@@ -101,4 +68,5 @@ Building config drives
^^^^^^^^^^^^^^^^^^^^^^
.. automodule:: openstack.baremetal.configdrive
:noindex:
:members:

10
doc/source/user/proxies/baremetal_introspection.rst
View File

@@ -16,10 +16,6 @@ Introspection Process Operations
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.baremetal_introspection.v1._proxy.Proxy
.. automethod:: openstack.baremetal_introspection.v1._proxy.Proxy.introspections
.. automethod:: openstack.baremetal_introspection.v1._proxy.Proxy.get_introspection
.. automethod:: openstack.baremetal_introspection.v1._proxy.Proxy.get_introspection_data
.. automethod:: openstack.baremetal_introspection.v1._proxy.Proxy.start_introspection
.. automethod:: openstack.baremetal_introspection.v1._proxy.Proxy.wait_for_introspection
.. automethod:: openstack.baremetal_introspection.v1._proxy.Proxy.abort_introspection
:noindex:
:members: introspections, get_introspection, get_introspection_data,
start_introspection, wait_for_introspection, abort_introspection

33
doc/source/user/proxies/block_storage.rst
View File

@@ -16,46 +16,33 @@ Volume Operations
^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.block_storage.v2._proxy.Proxy
.. automethod:: openstack.block_storage.v2._proxy.Proxy.create_volume
.. automethod:: openstack.block_storage.v2._proxy.Proxy.delete_volume
.. automethod:: openstack.block_storage.v2._proxy.Proxy.get_volume
.. automethod:: openstack.block_storage.v2._proxy.Proxy.volumes
:noindex:
:members: create_volume, delete_volume, get_volume, volumes
Backup Operations
^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.block_storage.v2._proxy.Proxy
.. automethod:: openstack.block_storage.v2._proxy.Proxy.create_backup
.. automethod:: openstack.block_storage.v2._proxy.Proxy.delete_backup
.. automethod:: openstack.block_storage.v2._proxy.Proxy.get_backup
.. automethod:: openstack.block_storage.v2._proxy.Proxy.backups
.. automethod:: openstack.block_storage.v2._proxy.Proxy.restore_backup
:noindex:
:members: create_backup, delete_backup, get_backup, backups, restore_backup
Type Operations
^^^^^^^^^^^^^^^
.. autoclass:: openstack.block_storage.v2._proxy.Proxy
.. automethod:: openstack.block_storage.v2._proxy.Proxy.create_type
.. automethod:: openstack.block_storage.v2._proxy.Proxy.delete_type
.. automethod:: openstack.block_storage.v2._proxy.Proxy.get_type
.. automethod:: openstack.block_storage.v2._proxy.Proxy.types
:noindex:
:members: create_type, delete_type, get_type, types
Snapshot Operations
^^^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.block_storage.v2._proxy.Proxy
.. automethod:: openstack.block_storage.v2._proxy.Proxy.create_snapshot
.. automethod:: openstack.block_storage.v2._proxy.Proxy.delete_snapshot
.. automethod:: openstack.block_storage.v2._proxy.Proxy.get_snapshot
.. automethod:: openstack.block_storage.v2._proxy.Proxy.snapshots
:noindex:
:members: create_snapshot, delete_snapshot, get_snapshot, snapshots
Stats Operations
^^^^^^^^^^^^^^^^
.. autoclass:: openstack.block_storage.v2._proxy.Proxy
.. automethod:: openstack.block_storage.v2._proxy.Proxy.backend_pools
:noindex:
:members: backend_pools

118
doc/source/user/proxies/clustering.rst
View File

@@ -15,151 +15,105 @@ Build Info Operations
^^^^^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.clustering.v1._proxy.Proxy
.. automethod:: openstack.clustering.v1._proxy.Proxy.get_build_info
:noindex:
:members: get_build_info
Profile Type Operations
^^^^^^^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.clustering.v1._proxy.Proxy
.. automethod:: openstack.clustering.v1._proxy.Proxy.profile_types
.. automethod:: openstack.clustering.v1._proxy.Proxy.get_profile_type
:noindex:
:members: profile_types, get_profile_type
Profile Operations
^^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.clustering.v1._proxy.Proxy
.. automethod:: openstack.clustering.v1._proxy.Proxy.create_profile
.. automethod:: openstack.clustering.v1._proxy.Proxy.update_profile
.. automethod:: openstack.clustering.v1._proxy.Proxy.delete_profile
.. automethod:: openstack.clustering.v1._proxy.Proxy.get_profile
.. automethod:: openstack.clustering.v1._proxy.Proxy.find_profile
.. automethod:: openstack.clustering.v1._proxy.Proxy.profiles
.. automethod:: openstack.clustering.v1._proxy.Proxy.validate_profile
:noindex:
:members: create_profile, update_profile, delete_profile, get_profile,
find_profile, profiles, validate_profile
Policy Type Operations
^^^^^^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.clustering.v1._proxy.Proxy
.. automethod:: openstack.clustering.v1._proxy.Proxy.policy_types
.. automethod:: openstack.clustering.v1._proxy.Proxy.get_policy_type
:noindex:
:members: policy_types, get_policy_type
Policy Operations
^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.clustering.v1._proxy.Proxy
:noindex:
:members: create_policy, update_policy, delete_policy, get_policy,
find_policy, policies
.. automethod:: openstack.clustering.v1._proxy.Proxy.create_policy
.. automethod:: openstack.clustering.v1._proxy.Proxy.update_policy
.. automethod:: openstack.clustering.v1._proxy.Proxy.delete_policy
.. automethod:: openstack.clustering.v1._proxy.Proxy.get_policy
.. automethod:: openstack.clustering.v1._proxy.Proxy.find_policy
.. automethod:: openstack.clustering.v1._proxy.Proxy.policies
.. automethod:: openstack.clustering.v1._proxy.Proxy.validate_policy
validate_policy
Cluster Operations
^^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.clustering.v1._proxy.Proxy
.. automethod:: openstack.clustering.v1._proxy.Proxy.create_cluster
.. automethod:: openstack.clustering.v1._proxy.Proxy.update_cluster
.. automethod:: openstack.clustering.v1._proxy.Proxy.delete_cluster
.. automethod:: openstack.clustering.v1._proxy.Proxy.get_cluster
.. automethod:: openstack.clustering.v1._proxy.Proxy.find_cluster
.. automethod:: openstack.clustering.v1._proxy.Proxy.clusters
.. automethod:: openstack.clustering.v1._proxy.Proxy.check_cluster
.. automethod:: openstack.clustering.v1._proxy.Proxy.recover_cluster
.. automethod:: openstack.clustering.v1._proxy.Proxy.resize_cluster
.. automethod:: openstack.clustering.v1._proxy.Proxy.scale_in_cluster
.. automethod:: openstack.clustering.v1._proxy.Proxy.scale_out_cluster
.. automethod:: openstack.clustering.v1._proxy.Proxy.collect_cluster_attrs
.. automethod:: openstack.clustering.v1._proxy.Proxy.perform_operation_on_cluster
.. automethod:: openstack.clustering.v1._proxy.Proxy.add_nodes_to_cluster
.. automethod:: openstack.clustering.v1._proxy.Proxy.remove_nodes_from_cluster
.. automethod:: openstack.clustering.v1._proxy.Proxy.replace_nodes_in_cluster
.. automethod:: openstack.clustering.v1._proxy.Proxy.attach_policy_to_cluster
.. automethod:: openstack.clustering.v1._proxy.Proxy.update_cluster_policy
.. automethod:: openstack.clustering.v1._proxy.Proxy.detach_policy_from_cluster
.. automethod:: openstack.clustering.v1._proxy.Proxy.get_cluster_policy
.. automethod:: openstack.clustering.v1._proxy.Proxy.cluster_policies
:noindex:
:members: create_cluster, update_cluster, delete_cluster, get_cluster,
find_cluster, clusters, check_cluster, recover_cluster,
resize_cluster, scale_in_cluster, scale_out_cluster,
collect_cluster_attrs, perform_operation_on_cluster,
add_nodes_to_cluster, remove_nodes_from_cluster,
replace_nodes_in_cluster, attach_policy_to_cluster,
update_cluster_policy, detach_policy_from_cluster,
get_cluster_policy, cluster_policies
Node Operations
^^^^^^^^^^^^^^^
.. autoclass:: openstack.clustering.v1._proxy.Proxy
.. automethod:: openstack.clustering.v1._proxy.Proxy.create_node
.. automethod:: openstack.clustering.v1._proxy.Proxy.update_node
.. automethod:: openstack.clustering.v1._proxy.Proxy.delete_node
.. automethod:: openstack.clustering.v1._proxy.Proxy.get_node
.. automethod:: openstack.clustering.v1._proxy.Proxy.find_node
.. automethod:: openstack.clustering.v1._proxy.Proxy.nodes
.. automethod:: openstack.clustering.v1._proxy.Proxy.check_node
.. automethod:: openstack.clustering.v1._proxy.Proxy.recover_node
.. automethod:: openstack.clustering.v1._proxy.Proxy.perform_operation_on_node
.. automethod:: openstack.clustering.v1._proxy.Proxy.adopt_node
:noindex:
:members: create_node, update_node, delete_node, get_node, find_node, nodes,
check_node, recover_node, perform_operation_on_node, adopt_node
Receiver Operations
^^^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.clustering.v1._proxy.Proxy
.. automethod:: openstack.clustering.v1._proxy.Proxy.create_receiver
.. automethod:: openstack.clustering.v1._proxy.Proxy.update_receiver
.. automethod:: openstack.clustering.v1._proxy.Proxy.delete_receiver
.. automethod:: openstack.clustering.v1._proxy.Proxy.get_receiver
.. automethod:: openstack.clustering.v1._proxy.Proxy.find_receiver
.. automethod:: openstack.clustering.v1._proxy.Proxy.receivers
:noindex:
:members: create_receiver, update_receiver, delete_receiver,
get_receiver, find_receiver, receivers
Action Operations
^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.clustering.v1._proxy.Proxy
.. automethod:: openstack.clustering.v1._proxy.Proxy.get_action
.. automethod:: openstack.clustering.v1._proxy.Proxy.actions
:noindex:
:members: get_action, actions
Event Operations
^^^^^^^^^^^^^^^^
.. autoclass:: openstack.clustering.v1._proxy.Proxy
.. automethod:: openstack.clustering.v1._proxy.Proxy.get_event
.. automethod:: openstack.clustering.v1._proxy.Proxy.events
:noindex:
:members: get_event, events
Helper Operations
^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.clustering.v1._proxy.Proxy
.. automethod:: openstack.clustering.v1._proxy.Proxy.wait_for_delete
.. automethod:: openstack.clustering.v1._proxy.Proxy.wait_for_status
:noindex:
:members: wait_for_delete, wait_for_status
Service Operations
^^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.clustering.v1._proxy.Proxy
.. automethod:: openstack.clustering.v1._proxy.Proxy.services
:noindex:
:members: services

152
doc/source/user/proxies/compute.rst
View File

@@ -17,180 +17,128 @@ Server Operations
^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.compute.v2._proxy.Proxy
.. automethod:: openstack.compute.v2._proxy.Proxy.create_server
.. automethod:: openstack.compute.v2._proxy.Proxy.update_server
.. automethod:: openstack.compute.v2._proxy.Proxy.delete_server
.. automethod:: openstack.compute.v2._proxy.Proxy.get_server
.. automethod:: openstack.compute.v2._proxy.Proxy.find_server
.. automethod:: openstack.compute.v2._proxy.Proxy.servers
.. automethod:: openstack.compute.v2._proxy.Proxy.get_server_metadata
.. automethod:: openstack.compute.v2._proxy.Proxy.set_server_metadata
.. automethod:: openstack.compute.v2._proxy.Proxy.delete_server_metadata
.. automethod:: openstack.compute.v2._proxy.Proxy.wait_for_server
.. automethod:: openstack.compute.v2._proxy.Proxy.create_server_image
.. automethod:: openstack.compute.v2._proxy.Proxy.backup_server
:noindex:
:members: create_server, update_server, delete_server, get_server,
find_server, servers, get_server_metadata, set_server_metadata,
delete_server_metadata, wait_for_server, create_server_image,
backup_server
Network Actions
***************
.. autoclass:: openstack.compute.v2._proxy.Proxy
.. automethod:: openstack.compute.v2._proxy.Proxy.add_fixed_ip_to_server
.. automethod:: openstack.compute.v2._proxy.Proxy.remove_fixed_ip_from_server
.. automethod:: openstack.compute.v2._proxy.Proxy.add_floating_ip_to_server
.. automethod:: openstack.compute.v2._proxy.Proxy.remove_floating_ip_from_server
.. automethod:: openstack.compute.v2._proxy.Proxy.fetch_server_security_groups
.. automethod:: openstack.compute.v2._proxy.Proxy.add_security_group_to_server
.. automethod:: openstack.compute.v2._proxy.Proxy.remove_security_group_from_server
:noindex:
:members: add_fixed_ip_to_server, remove_fixed_ip_from_server,
add_floating_ip_to_server, remove_floating_ip_from_server,
fetch_server_security_groups, add_security_group_to_server,
remove_security_group_from_server
Starting, Stopping, etc.
************************
.. autoclass:: openstack.compute.v2._proxy.Proxy
.. automethod:: openstack.compute.v2._proxy.Proxy.start_server
.. automethod:: openstack.compute.v2._proxy.Proxy.stop_server
.. automethod:: openstack.compute.v2._proxy.Proxy.suspend_server
.. automethod:: openstack.compute.v2._proxy.Proxy.resume_server
.. automethod:: openstack.compute.v2._proxy.Proxy.reboot_server
.. automethod:: openstack.compute.v2._proxy.Proxy.shelve_server
.. automethod:: openstack.compute.v2._proxy.Proxy.unshelve_server
.. automethod:: openstack.compute.v2._proxy.Proxy.lock_server
.. automethod:: openstack.compute.v2._proxy.Proxy.unlock_server
.. automethod:: openstack.compute.v2._proxy.Proxy.pause_server
.. automethod:: openstack.compute.v2._proxy.Proxy.unpause_server
.. automethod:: openstack.compute.v2._proxy.Proxy.rescue_server
.. automethod:: openstack.compute.v2._proxy.Proxy.unrescue_server
.. automethod:: openstack.compute.v2._proxy.Proxy.evacuate_server
.. automethod:: openstack.compute.v2._proxy.Proxy.migrate_server
.. automethod:: openstack.compute.v2._proxy.Proxy.get_server_console_output
.. automethod:: openstack.compute.v2._proxy.Proxy.live_migrate_server
:noindex:
:members: start_server, stop_server, suspend_server, resume_server,
reboot_server, shelve_server, unshelve_server, lock_server,
unlock_server, pause_server, unpause_server, rescue_server,
unrescue_server, evacuate_server, migrate_server,
get_server_console_output, live_migrate_server
Modifying a Server
******************
.. autoclass:: openstack.compute.v2._proxy.Proxy
.. automethod:: openstack.compute.v2._proxy.Proxy.resize_server
.. automethod:: openstack.compute.v2._proxy.Proxy.confirm_server_resize
.. automethod:: openstack.compute.v2._proxy.Proxy.revert_server_resize
.. automethod:: openstack.compute.v2._proxy.Proxy.rebuild_server
.. automethod:: openstack.compute.v2._proxy.Proxy.reset_server_state
.. automethod:: openstack.compute.v2._proxy.Proxy.change_server_password
.. automethod:: openstack.compute.v2._proxy.Proxy.get_server_password
:noindex:
:members: resize_server, confirm_server_resize, revert_server_resize,
rebuild_server, reset_server_state, change_server_password,
get_server_password
Image Operations
^^^^^^^^^^^^^^^^
.. autoclass:: openstack.compute.v2._proxy.Proxy
.. automethod:: openstack.compute.v2._proxy.Proxy.images
.. automethod:: openstack.compute.v2._proxy.Proxy.get_image
.. automethod:: openstack.compute.v2._proxy.Proxy.find_image
.. automethod:: openstack.compute.v2._proxy.Proxy.delete_image
.. automethod:: openstack.compute.v2._proxy.Proxy.get_image_metadata
.. automethod:: openstack.compute.v2._proxy.Proxy.set_image_metadata
.. automethod:: openstack.compute.v2._proxy.Proxy.delete_image_metadata
:noindex:
:members: images, get_image, find_image, delete_image, get_image_metadata,
set_image_metadata, delete_image_metadata
Flavor Operations
^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.compute.v2._proxy.Proxy
.. automethod:: openstack.compute.v2._proxy.Proxy.create_flavor
.. automethod:: openstack.compute.v2._proxy.Proxy.delete_flavor
.. automethod:: openstack.compute.v2._proxy.Proxy.get_flavor
.. automethod:: openstack.compute.v2._proxy.Proxy.find_flavor
.. automethod:: openstack.compute.v2._proxy.Proxy.flavors
:noindex:
:members: create_flavor, delete_flavor, get_flavor, find_flavor, flavors
Service Operations
^^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.compute.v2._proxy.Proxy
.. automethod:: openstack.compute.v2._proxy.Proxy.services
.. automethod:: openstack.compute.v2._proxy.Proxy.enable_service
.. automethod:: openstack.compute.v2._proxy.Proxy.disable_service
.. automethod:: openstack.compute.v2._proxy.Proxy.force_service_down
:noindex:
:members: services, enable_service, disable_service, force_service_down
Volume Attachment Operations
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.compute.v2._proxy.Proxy
.. automethod:: openstack.compute.v2._proxy.Proxy.create_volume_attachment
.. automethod:: openstack.compute.v2._proxy.Proxy.update_volume_attachment
.. automethod:: openstack.compute.v2._proxy.Proxy.delete_volume_attachment
.. automethod:: openstack.compute.v2._proxy.Proxy.get_volume_attachment
.. automethod:: openstack.compute.v2._proxy.Proxy.volume_attachments
:noindex:
:members: create_volume_attachment, update_volume_attachment,
delete_volume_attachment, get_volume_attachment,
volume_attachments
Keypair Operations
^^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.compute.v2._proxy.Proxy
.. automethod:: openstack.compute.v2._proxy.Proxy.create_keypair
.. automethod:: openstack.compute.v2._proxy.Proxy.delete_keypair
.. automethod:: openstack.compute.v2._proxy.Proxy.get_keypair
.. automethod:: openstack.compute.v2._proxy.Proxy.find_keypair
.. automethod:: openstack.compute.v2._proxy.Proxy.keypairs
:noindex:
:members: create_keypair, delete_keypair, get_keypair, find_keypair,
keypairs
Server IPs
^^^^^^^^^^
.. autoclass:: openstack.compute.v2._proxy.Proxy
.. automethod:: openstack.compute.v2._proxy.Proxy.server_ips
:noindex:
:members: server_ips
Server Group Operations
^^^^^^^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.compute.v2._proxy.Proxy
.. automethod:: openstack.compute.v2._proxy.Proxy.create_server_group
.. automethod:: openstack.compute.v2._proxy.Proxy.delete_server_group
.. automethod:: openstack.compute.v2._proxy.Proxy.get_server_group
.. automethod:: openstack.compute.v2._proxy.Proxy.find_server_group
.. automethod:: openstack.compute.v2._proxy.Proxy.server_groups
:noindex:
:members: create_server_group, delete_server_group, get_server_group,
find_server_group, server_groups
Server Interface Operations
^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.compute.v2._proxy.Proxy
.. automethod:: openstack.compute.v2._proxy.Proxy.create_server_interface
.. automethod:: openstack.compute.v2._proxy.Proxy.delete_server_interface
.. automethod:: openstack.compute.v2._proxy.Proxy.get_server_interface
.. automethod:: openstack.compute.v2._proxy.Proxy.server_interfaces
:noindex:
:members: create_server_interface, delete_server_interface,
get_server_interface, server_interfaces,
Availability Zone Operations
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.compute.v2._proxy.Proxy
.. automethod:: openstack.compute.v2._proxy.Proxy.availability_zones
:noindex:
:members: availability_zones
Limits Operations
^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.compute.v2._proxy.Proxy
.. automethod:: openstack.compute.v2._proxy.Proxy.get_limits
:noindex:
:members: get_limits
Hypervisor Operations
^^^^^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.compute.v2._proxy.Proxy
.. automethod:: openstack.compute.v2._proxy.Proxy.get_hypervisor
.. automethod:: openstack.compute.v2._proxy.Proxy.find_hypervisor
.. automethod:: openstack.compute.v2._proxy.Proxy.hypervisors
:noindex:
:members: get_hypervisor, find_hypervisor, hypervisors
Extension Operations
^^^^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.compute.v2._proxy.Proxy
.. automethod:: openstack.compute.v2._proxy.Proxy.find_extension
.. automethod:: openstack.compute.v2._proxy.Proxy.extensions
:noindex:
:members: find_extension, extensions

33
doc/source/user/proxies/database.rst
View File

@@ -16,41 +16,28 @@ Database Operations
^^^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.database.v1._proxy.Proxy
.. automethod:: openstack.database.v1._proxy.Proxy.create_database
.. automethod:: openstack.database.v1._proxy.Proxy.delete_database
.. automethod:: openstack.database.v1._proxy.Proxy.get_database
.. automethod:: openstack.database.v1._proxy.Proxy.find_database
.. automethod:: openstack.database.v1._proxy.Proxy.databases
:noindex:
:members: create_database, delete_database, get_database, find_database,
databases
Flavor Operations
^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.database.v1._proxy.Proxy
.. automethod:: openstack.database.v1._proxy.Proxy.get_flavor
.. automethod:: openstack.database.v1._proxy.Proxy.find_flavor
.. automethod:: openstack.database.v1._proxy.Proxy.flavors
:noindex:
:members: get_flavor, find_flavor, flavors
Instance Operations
^^^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.database.v1._proxy.Proxy
.. automethod:: openstack.database.v1._proxy.Proxy.create_instance
.. automethod:: openstack.database.v1._proxy.Proxy.update_instance
.. automethod:: openstack.database.v1._proxy.Proxy.delete_instance
.. automethod:: openstack.database.v1._proxy.Proxy.get_instance
.. automethod:: openstack.database.v1._proxy.Proxy.find_instance
.. automethod:: openstack.database.v1._proxy.Proxy.instances
:noindex:
:members: create_instance, update_instance, delete_instance, get_instance,
find_instance, instances
User Operations
^^^^^^^^^^^^^^^
.. autoclass:: openstack.database.v1._proxy.Proxy
.. automethod:: openstack.database.v1._proxy.Proxy.create_user
.. automethod:: openstack.database.v1._proxy.Proxy.delete_user
.. automethod:: openstack.database.v1._proxy.Proxy.get_user
.. automethod:: openstack.database.v1._proxy.Proxy.find_user
.. automethod:: openstack.database.v1._proxy.Proxy.users
:noindex:
:members: create_user, delete_user, get_user, find_user, users

57
doc/source/user/proxies/dns.rst
View File

@@ -16,66 +16,47 @@ DNS Zone Operations
^^^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.dns.v2._proxy.Proxy
.. automethod:: openstack.dns.v2._proxy.Proxy.create_zone
.. automethod:: openstack.dns.v2._proxy.Proxy.delete_zone
.. automethod:: openstack.dns.v2._proxy.Proxy.get_zone
.. automethod:: openstack.dns.v2._proxy.Proxy.find_zone
.. automethod:: openstack.dns.v2._proxy.Proxy.zones
.. automethod:: openstack.dns.v2._proxy.Proxy.abandon_zone
.. automethod:: openstack.dns.v2._proxy.Proxy.xfr_zone
:noindex:
:members: create_zone, delete_zone, get_zone, find_zone, zones,
abandon_zone, xfr_zone
Recordset Operations
^^^^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.dns.v2._proxy.Proxy
.. automethod:: openstack.dns.v2._proxy.Proxy.create_recordset
.. automethod:: openstack.dns.v2._proxy.Proxy.update_recordset
.. automethod:: openstack.dns.v2._proxy.Proxy.get_recordset
.. automethod:: openstack.dns.v2._proxy.Proxy.delete_recordset
.. automethod:: openstack.dns.v2._proxy.Proxy.recordsets
:noindex:
:members: create_recordset, update_recordset, get_recordset,
delete_recordset, recordsets
Zone Import Operations
^^^^^^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.dns.v2._proxy.Proxy
.. automethod:: openstack.dns.v2._proxy.Proxy.zone_imports
.. automethod:: openstack.dns.v2._proxy.Proxy.create_zone_import
.. automethod:: openstack.dns.v2._proxy.Proxy.get_zone_import
.. automethod:: openstack.dns.v2._proxy.Proxy.delete_zone_import
:noindex:
:members: zone_imports, create_zone_import, get_zone_import,
delete_zone_import
Zone Export Operations
^^^^^^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.dns.v2._proxy.Proxy
.. automethod:: openstack.dns.v2._proxy.Proxy.zone_exports
.. automethod:: openstack.dns.v2._proxy.Proxy.create_zone_export
.. automethod:: openstack.dns.v2._proxy.Proxy.get_zone_export
.. automethod:: openstack.dns.v2._proxy.Proxy.get_zone_export_text
.. automethod:: openstack.dns.v2._proxy.Proxy.delete_zone_export
:noindex:
:members: zone_exports, create_zone_export, get_zone_export,
get_zone_export_text, delete_zone_export
FloatingIP Operations
^^^^^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.dns.v2._proxy.Proxy
.. automethod:: openstack.dns.v2._proxy.Proxy.floating_ips
.. automethod:: openstack.dns.v2._proxy.Proxy.get_floating_ip
.. automethod:: openstack.dns.v2._proxy.Proxy.update_floating_ip
:noindex:
:members: floating_ips, get_floating_ip, update_floating_ip
Zone Transfer Operations
^^^^^^^^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.dns.v2._proxy.Proxy
.. automethod:: openstack.dns.v2._proxy.Proxy.zone_transfer_requests
.. automethod:: openstack.dns.v2._proxy.Proxy.get_zone_transfer_request
.. automethod:: openstack.dns.v2._proxy.Proxy.create_zone_transfer_request
.. automethod:: openstack.dns.v2._proxy.Proxy.update_zone_transfer_request
.. automethod:: openstack.dns.v2._proxy.Proxy.delete_zone_transfer_request
.. automethod:: openstack.dns.v2._proxy.Proxy.zone_transfer_accepts
.. automethod:: openstack.dns.v2._proxy.Proxy.get_zone_transfer_accept
.. automethod:: openstack.dns.v2._proxy.Proxy.create_zone_transfer_accept
:noindex:
:members: zone_transfer_requests, get_zone_transfer_request,
create_zone_transfer_request, update_zone_transfer_request,
delete_zone_transfer_request, zone_transfer_accepts,
get_zone_transfer_accept, create_zone_transfer_accept

33
doc/source/user/proxies/identity_v2.rst
View File

@@ -16,42 +16,27 @@ Extension Operations
^^^^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.identity.v2._proxy.Proxy
.. automethod:: openstack.identity.v2._proxy.Proxy.get_extension
.. automethod:: openstack.identity.v2._proxy.Proxy.extensions
:noindex:
:members: get_extension, extensions
User Operations
^^^^^^^^^^^^^^^
.. autoclass:: openstack.identity.v2._proxy.Proxy
.. automethod:: openstack.identity.v2._proxy.Proxy.create_user
.. automethod:: openstack.identity.v2._proxy.Proxy.update_user
.. automethod:: openstack.identity.v2._proxy.Proxy.delete_user
.. automethod:: openstack.identity.v2._proxy.Proxy.get_user
.. automethod:: openstack.identity.v2._proxy.Proxy.find_user
.. automethod:: openstack.identity.v2._proxy.Proxy.users
:noindex:
:members: create_user, update_user, delete_user, get_user, find_user, users
Role Operations
^^^^^^^^^^^^^^^
.. autoclass:: openstack.identity.v2._proxy.Proxy
.. automethod:: openstack.identity.v2._proxy.Proxy.create_role
.. automethod:: openstack.identity.v2._proxy.Proxy.update_role
.. automethod:: openstack.identity.v2._proxy.Proxy.delete_role
.. automethod:: openstack.identity.v2._proxy.Proxy.get_role
.. automethod:: openstack.identity.v2._proxy.Proxy.find_role
.. automethod:: openstack.identity.v2._proxy.Proxy.roles
:noindex:
:members: create_role, update_role, delete_role, get_role, find_role, roles
Tenant Operations
^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.identity.v2._proxy.Proxy
.. automethod:: openstack.identity.v2._proxy.Proxy.create_tenant
.. automethod:: openstack.identity.v2._proxy.Proxy.update_tenant
.. automethod:: openstack.identity.v2._proxy.Proxy.delete_tenant
.. automethod:: openstack.identity.v2._proxy.Proxy.get_tenant
.. automethod:: openstack.identity.v2._proxy.Proxy.find_tenant
.. automethod:: openstack.identity.v2._proxy.Proxy.tenants
:noindex:
:members: create_tenant, update_tenant, delete_tenant, get_tenant,
find_tenant, tenants

121
doc/source/user/proxies/identity_v3.rst
View File

@@ -16,144 +16,93 @@ Credential Operations
^^^^^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.identity.v3._proxy.Proxy
.. automethod:: openstack.identity.v3._proxy.Proxy.create_credential
.. automethod:: openstack.identity.v3._proxy.Proxy.update_credential
.. automethod:: openstack.identity.v3._proxy.Proxy.delete_credential
.. automethod:: openstack.identity.v3._proxy.Proxy.get_credential
.. automethod:: openstack.identity.v3._proxy.Proxy.find_credential
.. automethod:: openstack.identity.v3._proxy.Proxy.credentials
:noindex:
:members: create_credential, update_credential, delete_credential,
get_credential, find_credential, credentials
Domain Operations
^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.identity.v3._proxy.Proxy
.. automethod:: openstack.identity.v3._proxy.Proxy.create_domain
.. automethod:: openstack.identity.v3._proxy.Proxy.update_domain
.. automethod:: openstack.identity.v3._proxy.Proxy.delete_domain
.. automethod:: openstack.identity.v3._proxy.Proxy.get_domain
.. automethod:: openstack.identity.v3._proxy.Proxy.find_domain
.. automethod:: openstack.identity.v3._proxy.Proxy.domains
:noindex:
:members: create_domain, update_domain, delete_domain, get_domain,
find_domain, domains
Endpoint Operations
^^^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.identity.v3._proxy.Proxy
.. automethod:: openstack.identity.v3._proxy.Proxy.create_endpoint
.. automethod:: openstack.identity.v3._proxy.Proxy.update_endpoint
.. automethod:: openstack.identity.v3._proxy.Proxy.delete_endpoint
.. automethod:: openstack.identity.v3._proxy.Proxy.get_endpoint
.. automethod:: openstack.identity.v3._proxy.Proxy.find_endpoint
.. automethod:: openstack.identity.v3._proxy.Proxy.endpoints
:noindex:
:members: create_endpoint, update_endpoint, delete_endpoint, get_endpoint,
find_endpoint, endpoints
Group Operations
^^^^^^^^^^^^^^^^
.. autoclass:: openstack.identity.v3._proxy.Proxy
.. automethod:: openstack.identity.v3._proxy.Proxy.create_group
.. automethod:: openstack.identity.v3._proxy.Proxy.update_group
.. automethod:: openstack.identity.v3._proxy.Proxy.delete_group
.. automethod:: openstack.identity.v3._proxy.Proxy.get_group
.. automethod:: openstack.identity.v3._proxy.Proxy.find_group
.. automethod:: openstack.identity.v3._proxy.Proxy.groups
:noindex:
:members: create_group, update_group, delete_group, get_group, find_group,
groups
Policy Operations
^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.identity.v3._proxy.Proxy
.. automethod:: openstack.identity.v3._proxy.Proxy.create_policy
.. automethod:: openstack.identity.v3._proxy.Proxy.update_policy
.. automethod:: openstack.identity.v3._proxy.Proxy.delete_policy
.. automethod:: openstack.identity.v3._proxy.Proxy.get_policy
.. automethod:: openstack.identity.v3._proxy.Proxy.find_policy
.. automethod:: openstack.identity.v3._proxy.Proxy.policies
:noindex:
:members: create_policy, update_policy, delete_policy, get_policy,
find_policy, policies
Project Operations
^^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.identity.v3._proxy.Proxy
.. automethod:: openstack.identity.v3._proxy.Proxy.create_project
.. automethod:: openstack.identity.v3._proxy.Proxy.update_project
.. automethod:: openstack.identity.v3._proxy.Proxy.delete_project
.. automethod:: openstack.identity.v3._proxy.Proxy.get_project
.. automethod:: openstack.identity.v3._proxy.Proxy.find_project
.. automethod:: openstack.identity.v3._proxy.Proxy.projects
:noindex:
:members: create_project, update_project, delete_project, get_project,
find_project, projects
Region Operations
^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.identity.v3._proxy.Proxy
.. automethod:: openstack.identity.v3._proxy.Proxy.create_region
.. automethod:: openstack.identity.v3._proxy.Proxy.update_region
.. automethod:: openstack.identity.v3._proxy.Proxy.delete_region
.. automethod:: openstack.identity.v3._proxy.Proxy.get_region
.. automethod:: openstack.identity.v3._proxy.Proxy.find_region
.. automethod:: openstack.identity.v3._proxy.Proxy.regions
:noindex:
:members: create_region, update_region, delete_region, get_region,
find_region, regions
Role Operations
^^^^^^^^^^^^^^^
.. autoclass:: openstack.identity.v3._proxy.Proxy
.. automethod:: openstack.identity.v3._proxy.Proxy.create_role
.. automethod:: openstack.identity.v3._proxy.Proxy.update_role
.. automethod:: openstack.identity.v3._proxy.Proxy.delete_role
.. automethod:: openstack.identity.v3._proxy.Proxy.get_role
.. automethod:: openstack.identity.v3._proxy.Proxy.find_role
.. automethod:: openstack.identity.v3._proxy.Proxy.roles
:noindex:
:members: create_role, update_role, delete_role, get_role, find_role, roles
Role Assignment Operations
^^^^^^^^^^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.identity.v3._proxy.Proxy
.. automethod:: openstack.identity.v3._proxy.Proxy.role_assignments
.. automethod:: openstack.identity.v3._proxy.Proxy.role_assignments_filter
.. automethod:: openstack.identity.v3._proxy.Proxy.assign_project_role_to_user
.. automethod:: openstack.identity.v3._proxy.Proxy.unassign_project_role_from_user
.. automethod:: openstack.identity.v3._proxy.Proxy.validate_user_has_role
.. automethod:: openstack.identity.v3._proxy.Proxy.assign_project_role_to_group
.. automethod:: openstack.identity.v3._proxy.Proxy.unassign_project_role_from_group
.. automethod:: openstack.identity.v3._proxy.Proxy.validate_group_has_role
:noindex:
:members: role_assignments, role_assignments_filter,
assign_project_role_to_user, unassign_project_role_from_user,
validate_user_has_role, assign_project_role_to_group,
unassign_project_role_from_group, validate_group_has_role
Service Operations
^^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.identity.v3._proxy.Proxy
.. automethod:: openstack.identity.v3._proxy.Proxy.create_service
.. automethod:: openstack.identity.v3._proxy.Proxy.update_service
.. automethod:: openstack.identity.v3._proxy.Proxy.delete_service
.. automethod:: openstack.identity.v3._proxy.Proxy.get_service
.. automethod:: openstack.identity.v3._proxy.Proxy.find_service
.. automethod:: openstack.identity.v3._proxy.Proxy.services
:noindex:
:members: create_service, update_service, delete_service, get_service,
find_service, services
Trust Operations
^^^^^^^^^^^^^^^^
.. autoclass:: openstack.identity.v3._proxy.Proxy
.. automethod:: openstack.identity.v3._proxy.Proxy.create_trust
.. automethod:: openstack.identity.v3._proxy.Proxy.delete_trust
.. automethod:: openstack.identity.v3._proxy.Proxy.get_trust
.. automethod:: openstack.identity.v3._proxy.Proxy.find_trust
.. automethod:: openstack.identity.v3._proxy.Proxy.trusts
:noindex:
:members: create_trust, delete_trust, get_trust, find_trust, trusts
User Operations
^^^^^^^^^^^^^^^
.. autoclass:: openstack.identity.v3._proxy.Proxy
.. automethod:: openstack.identity.v3._proxy.Proxy.create_user
.. automethod:: openstack.identity.v3._proxy.Proxy.update_user
.. automethod:: openstack.identity.v3._proxy.Proxy.delete_user
.. automethod:: openstack.identity.v3._proxy.Proxy.get_user
.. automethod:: openstack.identity.v3._proxy.Proxy.find_user
.. automethod:: openstack.identity.v3._proxy.Proxy.users
:noindex:
:members: create_user, update_user, delete_user, get_user, find_user, users

10
doc/source/user/proxies/image_v1.rst
View File

@@ -13,10 +13,6 @@ The image high-level interface is available through the ``image`` member of a
only be added if the service is detected.
.. autoclass:: openstack.image.v1._proxy.Proxy
.. automethod:: openstack.image.v1._proxy.Proxy.upload_image
.. automethod:: openstack.image.v1._proxy.Proxy.update_image
.. automethod:: openstack.image.v1._proxy.Proxy.delete_image
.. automethod:: openstack.image.v1._proxy.Proxy.get_image
.. automethod:: openstack.image.v1._proxy.Proxy.find_image
.. automethod:: openstack.image.v1._proxy.Proxy.images
:noindex:
:members: upload_image, update_image, delete_image, get_image, find_image,
images

52
doc/source/user/proxies/image_v2.rst
View File

@@ -16,60 +16,38 @@ Image Operations
^^^^^^^^^^^^^^^^
.. autoclass:: openstack.image.v2._proxy.Proxy
.. automethod:: openstack.image.v2._proxy.Proxy.create_image
.. automethod:: openstack.image.v2._proxy.Proxy.import_image
.. automethod:: openstack.image.v2._proxy.Proxy.upload_image
.. automethod:: openstack.image.v2._proxy.Proxy.download_image
.. automethod:: openstack.image.v2._proxy.Proxy.update_image
.. automethod:: openstack.image.v2._proxy.Proxy.delete_image
.. automethod:: openstack.image.v2._proxy.Proxy.get_image
.. automethod:: openstack.image.v2._proxy.Proxy.find_image
.. automethod:: openstack.image.v2._proxy.Proxy.images
.. automethod:: openstack.image.v2._proxy.Proxy.deactivate_image
.. automethod:: openstack.image.v2._proxy.Proxy.reactivate_image
.. automethod:: openstack.image.v2._proxy.Proxy.stage_image
.. automethod:: openstack.image.v2._proxy.Proxy.add_tag
.. automethod:: openstack.image.v2._proxy.Proxy.remove_tag
:noindex:
:members: create_image, import_image, upload_image, download_image,
update_image, delete_image, get_image, find_image, images,
deactivate_image, reactivate_image, stage_image,
add_tag, remove_tag
Member Operations
^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.image.v2._proxy.Proxy
.. automethod:: openstack.image.v2._proxy.Proxy.add_member
.. automethod:: openstack.image.v2._proxy.Proxy.remove_member
.. automethod:: openstack.image.v2._proxy.Proxy.update_member
.. automethod:: openstack.image.v2._proxy.Proxy.get_member
.. automethod:: openstack.image.v2._proxy.Proxy.find_member
.. automethod:: openstack.image.v2._proxy.Proxy.members
:noindex:
:members: add_member, remove_member, update_member, get_member, find_member,
members
Task Operations
^^^^^^^^^^^^^^^
.. autoclass:: openstack.image.v2._proxy.Proxy
.. automethod:: openstack.image.v2._proxy.Proxy.tasks
.. automethod:: openstack.image.v2._proxy.Proxy.create_task
.. automethod:: openstack.image.v2._proxy.Proxy.get_task
.. automethod:: openstack.image.v2._proxy.Proxy.wait_for_task
:noindex:
:members: tasks, create_task, get_task, wait_for_task
Schema Operations
^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.image.v2._proxy.Proxy
.. automethod:: openstack.image.v2._proxy.Proxy.get_images_schema
.. automethod:: openstack.image.v2._proxy.Proxy.get_image_schema
.. automethod:: openstack.image.v2._proxy.Proxy.get_members_schema
.. automethod:: openstack.image.v2._proxy.Proxy.get_member_schema
.. automethod:: openstack.image.v2._proxy.Proxy.get_tasks_schema
.. automethod:: openstack.image.v2._proxy.Proxy.get_task_schema
:noindex:
:members: get_images_schema, get_image_schema, get_members_schema,
get_member_schema, get_tasks_schema, get_task_schema
Service Info Discovery Operations
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.image.v2._proxy.Proxy
.. automethod:: openstack.image.v2._proxy.Proxy.stores
.. automethod:: openstack.image.v2._proxy.Proxy.get_import_info
:noindex:
:members: stores, get_import_info

30
doc/source/user/proxies/key_manager.rst
View File

@@ -18,34 +18,22 @@ Secret Operations
^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.key_manager.v1._proxy.Proxy
.. automethod:: openstack.key_manager.v1._proxy.Proxy.create_secret
.. automethod:: openstack.key_manager.v1._proxy.Proxy.update_secret
.. automethod:: openstack.key_manager.v1._proxy.Proxy.delete_secret
.. automethod:: openstack.key_manager.v1._proxy.Proxy.get_secret
.. automethod:: openstack.key_manager.v1._proxy.Proxy.find_secret
.. automethod:: openstack.key_manager.v1._proxy.Proxy.secrets
:noindex:
:members: create_secret, update_secret, delete_secret, get_secret,
find_secret, secrets
Container Operations
^^^^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.key_manager.v1._proxy.Proxy
.. automethod:: openstack.key_manager.v1._proxy.Proxy.create_container
.. automethod:: openstack.key_manager.v1._proxy.Proxy.update_container
.. automethod:: openstack.key_manager.v1._proxy.Proxy.delete_container
.. automethod:: openstack.key_manager.v1._proxy.Proxy.get_container
.. automethod:: openstack.key_manager.v1._proxy.Proxy.find_container
.. automethod:: openstack.key_manager.v1._proxy.Proxy.containers
:noindex:
:members: create_container, update_container, delete_container,
get_container, find_container, containers
Order Operations
^^^^^^^^^^^^^^^^
.. autoclass:: openstack.key_manager.v1._proxy.Proxy
.. automethod:: openstack.key_manager.v1._proxy.Proxy.create_order
.. automethod:: openstack.key_manager.v1._proxy.Proxy.update_order
.. automethod:: openstack.key_manager.v1._proxy.Proxy.delete_order
.. automethod:: openstack.key_manager.v1._proxy.Proxy.get_order
.. automethod:: openstack.key_manager.v1._proxy.Proxy.find_order
.. automethod:: openstack.key_manager.v1._proxy.Proxy.orders
:noindex:
:members: create_order, update_order, delete_order, get_order,
find_order, orders

138
doc/source/user/proxies/load_balancer_v2.rst
View File

@@ -14,164 +14,110 @@ Load Balancer Operations
^^^^^^^^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.load_balancer.v2._proxy.Proxy
.. automethod:: openstack.load_balancer.v2._proxy.Proxy.create_load_balancer
.. automethod:: openstack.load_balancer.v2._proxy.Proxy.delete_load_balancer
.. automethod:: openstack.load_balancer.v2._proxy.Proxy.find_load_balancer
.. automethod:: openstack.load_balancer.v2._proxy.Proxy.get_load_balancer
.. automethod:: openstack.load_balancer.v2._proxy.Proxy.get_load_balancer_statistics
.. automethod:: openstack.load_balancer.v2._proxy.Proxy.load_balancers
.. automethod:: openstack.load_balancer.v2._proxy.Proxy.update_load_balancer
.. automethod:: openstack.load_balancer.v2._proxy.Proxy.failover_load_balancer
:noindex:
:members: create_load_balancer, delete_load_balancer, find_load_balancer,
get_load_balancer, get_load_balancer_statistics, load_balancers,
update_load_balancer, failover_load_balancer
Listener Operations
^^^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.load_balancer.v2._proxy.Proxy
.. automethod:: openstack.load_balancer.v2._proxy.Proxy.create_listener
.. automethod:: openstack.load_balancer.v2._proxy.Proxy.delete_listener
.. automethod:: openstack.load_balancer.v2._proxy.Proxy.find_listener
.. automethod:: openstack.load_balancer.v2._proxy.Proxy.get_listener
.. automethod:: openstack.load_balancer.v2._proxy.Proxy.get_listener_statistics
.. automethod:: openstack.load_balancer.v2._proxy.Proxy.listeners
.. automethod:: openstack.load_balancer.v2._proxy.Proxy.update_listener
:noindex:
:members: create_listener, delete_listener, find_listener, get_listener,
get_listener_statistics, listeners, update_listener
Pool Operations
^^^^^^^^^^^^^^^
.. autoclass:: openstack.load_balancer.v2._proxy.Proxy
.. automethod:: openstack.load_balancer.v2._proxy.Proxy.create_pool
.. automethod:: openstack.load_balancer.v2._proxy.Proxy.delete_pool
.. automethod:: openstack.load_balancer.v2._proxy.Proxy.find_pool
.. automethod:: openstack.load_balancer.v2._proxy.Proxy.get_pool
.. automethod:: openstack.load_balancer.v2._proxy.Proxy.pools
.. automethod:: openstack.load_balancer.v2._proxy.Proxy.update_pool
:noindex:
:members: create_pool, delete_pool, find_pool, get_pool, pools, update_pool
Member Operations
^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.load_balancer.v2._proxy.Proxy
.. automethod:: openstack.load_balancer.v2._proxy.Proxy.create_member
.. automethod:: openstack.load_balancer.v2._proxy.Proxy.delete_member
.. automethod:: openstack.load_balancer.v2._proxy.Proxy.find_member
.. automethod:: openstack.load_balancer.v2._proxy.Proxy.get_member
.. automethod:: openstack.load_balancer.v2._proxy.Proxy.members
.. automethod:: openstack.load_balancer.v2._proxy.Proxy.update_member
:noindex:
:members: create_member, delete_member, find_member, get_member, members,
update_member
Health Monitor Operations
^^^^^^^^^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.load_balancer.v2._proxy.Proxy
.. automethod:: openstack.load_balancer.v2._proxy.Proxy.create_health_monitor
.. automethod:: openstack.load_balancer.v2._proxy.Proxy.delete_health_monitor
.. automethod:: openstack.load_balancer.v2._proxy.Proxy.find_health_monitor
.. automethod:: openstack.load_balancer.v2._proxy.Proxy.get_health_monitor
.. automethod:: openstack.load_balancer.v2._proxy.Proxy.health_monitors
.. automethod:: openstack.load_balancer.v2._proxy.Proxy.update_health_monitor
:noindex:
:members: create_health_monitor, delete_health_monitor, find_health_monitor,
get_health_monitor, health_monitors, update_health_monitor
L7 Policy Operations
^^^^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.load_balancer.v2._proxy.Proxy
.. automethod:: openstack.load_balancer.v2._proxy.Proxy.create_l7_policy
.. automethod:: openstack.load_balancer.v2._proxy.Proxy.delete_l7_policy
.. automethod:: openstack.load_balancer.v2._proxy.Proxy.find_l7_policy
.. automethod:: openstack.load_balancer.v2._proxy.Proxy.get_l7_policy
.. automethod:: openstack.load_balancer.v2._proxy.Proxy.l7_policies
.. automethod:: openstack.load_balancer.v2._proxy.Proxy.update_l7_policy
:noindex:
:members: create_l7_policy, delete_l7_policy, find_l7_policy,
get_l7_policy, l7_policies, update_l7_policy
L7 Rule Operations
^^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.load_balancer.v2._proxy.Proxy
.. automethod:: openstack.load_balancer.v2._proxy.Proxy.create_l7_rule
.. automethod:: openstack.load_balancer.v2._proxy.Proxy.delete_l7_rule
.. automethod:: openstack.load_balancer.v2._proxy.Proxy.find_l7_rule
.. automethod:: openstack.load_balancer.v2._proxy.Proxy.get_l7_rule
.. automethod:: openstack.load_balancer.v2._proxy.Proxy.l7_rules
.. automethod:: openstack.load_balancer.v2._proxy.Proxy.update_l7_rule
:noindex:
:members: create_l7_rule, delete_l7_rule, find_l7_rule,
get_l7_rule, l7_rules, update_l7_rule
Provider Operations
^^^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.load_balancer.v2._proxy.Proxy
.. automethod:: openstack.load_balancer.v2._proxy.Proxy.providers
.. automethod:: openstack.load_balancer.v2._proxy.Proxy.provider_flavor_capabilities
:noindex:
:members: providers, provider_flavor_capabilities
Flavor Profile Operations
^^^^^^^^^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.load_balancer.v2._proxy.Proxy
.. automethod:: openstack.load_balancer.v2._proxy.Proxy.create_flavor_profile
.. automethod:: openstack.load_balancer.v2._proxy.Proxy.get_flavor_profile
.. automethod:: openstack.load_balancer.v2._proxy.Proxy.flavor_profiles
.. automethod:: openstack.load_balancer.v2._proxy.Proxy.delete_flavor_profile
.. automethod:: openstack.load_balancer.v2._proxy.Proxy.find_flavor_profile
.. automethod:: openstack.load_balancer.v2._proxy.Proxy.update_flavor_profile
:noindex:
:members: create_flavor_profile, get_flavor_profile, flavor_profiles,
delete_flavor_profile, find_flavor_profile, update_flavor_profile
Flavor Operations
^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.load_balancer.v2._proxy.Proxy
.. automethod:: openstack.load_balancer.v2._proxy.Proxy.create_flavor
.. automethod:: openstack.load_balancer.v2._proxy.Proxy.get_flavor
.. automethod:: openstack.load_balancer.v2._proxy.Proxy.flavors
.. automethod:: openstack.load_balancer.v2._proxy.Proxy.delete_flavor
.. automethod:: openstack.load_balancer.v2._proxy.Proxy.find_flavor
.. automethod:: openstack.load_balancer.v2._proxy.Proxy.update_flavor
:noindex:
:members: create_flavor, get_flavor, flavors, delete_flavor,
find_flavor, update_flavor
Quota Operations
^^^^^^^^^^^^^^^^
.. autoclass:: openstack.load_balancer.v2._proxy.Proxy
.. automethod:: openstack.load_balancer.v2._proxy.Proxy.update_quota
.. automethod:: openstack.load_balancer.v2._proxy.Proxy.delete_quota
.. automethod:: openstack.load_balancer.v2._proxy.Proxy.quotas
.. automethod:: openstack.load_balancer.v2._proxy.Proxy.get_quota
.. automethod:: openstack.load_balancer.v2._proxy.Proxy.get_quota_default
:noindex:
:members: update_quota, delete_quota, quotas, get_quota, get_quota_default
Amphora Operations
^^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.load_balancer.v2._proxy.Proxy
.. automethod:: openstack.load_balancer.v2._proxy.Proxy.amphorae
.. automethod:: openstack.load_balancer.v2._proxy.Proxy.get_amphora
.. automethod:: openstack.load_balancer.v2._proxy.Proxy.find_amphora
.. automethod:: openstack.load_balancer.v2._proxy.Proxy.configure_amphora
.. automethod:: openstack.load_balancer.v2._proxy.Proxy.failover_amphora
:noindex:
:members: amphorae, get_amphora, find_amphora, configure_amphora,
failover_amphora
Availability Zone Profile Operations
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.load_balancer.v2._proxy.Proxy
.. automethod:: openstack.load_balancer.v2._proxy.Proxy.create_availability_zone_profile
.. automethod:: openstack.load_balancer.v2._proxy.Proxy.get_availability_zone_profile
.. automethod:: openstack.load_balancer.v2._proxy.Proxy.availability_zone_profiles
.. automethod:: openstack.load_balancer.v2._proxy.Proxy.delete_availability_zone_profile
.. automethod:: openstack.load_balancer.v2._proxy.Proxy.find_availability_zone_profile
.. automethod:: openstack.load_balancer.v2._proxy.Proxy.update_availability_zone_profile
:noindex:
:members: create_availability_zone_profile, get_availability_zone_profile,
availability_zone_profiles, delete_availability_zone_profile,
find_availability_zone_profile, update_availability_zone_profile
Availability Zone Operations
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.load_balancer.v2._proxy.Proxy
.. automethod:: openstack.load_balancer.v2._proxy.Proxy.create_availability_zone
.. automethod:: openstack.load_balancer.v2._proxy.Proxy.get_availability_zone
.. automethod:: openstack.load_balancer.v2._proxy.Proxy.availability_zones
.. automethod:: openstack.load_balancer.v2._proxy.Proxy.delete_availability_zone
.. automethod:: openstack.load_balancer.v2._proxy.Proxy.find_availability_zone
.. automethod:: openstack.load_balancer.v2._proxy.Proxy.update_availability_zone
:noindex:
:members: create_availability_zone, get_availability_zone,
availability_zones, delete_availability_zone,
find_availability_zone, update_availability_zone

29
doc/source/user/proxies/message_v2.rst
View File

@@ -16,38 +16,27 @@ Message Operations
^^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.message.v2._proxy.Proxy
.. automethod:: openstack.message.v2._proxy.Proxy.post_message
.. automethod:: openstack.message.v2._proxy.Proxy.delete_message
.. automethod:: openstack.message.v2._proxy.Proxy.get_message
.. automethod:: openstack.message.v2._proxy.Proxy.messages
:noindex:
:members: post_message, delete_message, get_message, messages
Queue Operations
^^^^^^^^^^^^^^^^
.. autoclass:: openstack.message.v2._proxy.Proxy
.. automethod:: openstack.message.v2._proxy.Proxy.create_queue
.. automethod:: openstack.message.v2._proxy.Proxy.delete_queue
.. automethod:: openstack.message.v2._proxy.Proxy.get_queue
.. automethod:: openstack.message.v2._proxy.Proxy.queues
:noindex:
:members: create_queue, delete_queue, get_queue, queues
Claim Operations
^^^^^^^^^^^^^^^^
.. autoclass:: openstack.message.v2._proxy.Proxy
.. automethod:: openstack.message.v2._proxy.Proxy.create_claim
.. automethod:: openstack.message.v2._proxy.Proxy.update_claim
.. automethod:: openstack.message.v2._proxy.Proxy.delete_claim
.. automethod:: openstack.message.v2._proxy.Proxy.get_claim
:noindex:
:members: create_claim, update_claim, delete_claim, get_claim
Subscription Operations
^^^^^^^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.message.v2._proxy.Proxy
.. automethod:: openstack.message.v2._proxy.Proxy.create_subscription
.. automethod:: openstack.message.v2._proxy.Proxy.delete_subscription
.. automethod:: openstack.message.v2._proxy.Proxy.get_subscription
.. automethod:: openstack.message.v2._proxy.Proxy.subscriptions
:noindex:
:members: create_subscription, delete_subscription, get_subscription,
subscriptions

339
doc/source/user/proxies/network.rst
View File

@@ -16,355 +16,230 @@ Network Operations
^^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.network.v2._proxy.Proxy
.. automethod:: openstack.network.v2._proxy.Proxy.create_network
.. automethod:: openstack.network.v2._proxy.Proxy.update_network
.. automethod:: openstack.network.v2._proxy.Proxy.delete_network
.. automethod:: openstack.network.v2._proxy.Proxy.get_network
.. automethod:: openstack.network.v2._proxy.Proxy.find_network
.. automethod:: openstack.network.v2._proxy.Proxy.networks
.. automethod:: openstack.network.v2._proxy.Proxy.get_network_ip_availability
.. automethod:: openstack.network.v2._proxy.Proxy.find_network_ip_availability
.. automethod:: openstack.network.v2._proxy.Proxy.network_ip_availabilities
.. automethod:: openstack.network.v2._proxy.Proxy.add_dhcp_agent_to_network
.. automethod:: openstack.network.v2._proxy.Proxy.remove_dhcp_agent_from_network
.. automethod:: openstack.network.v2._proxy.Proxy.dhcp_agent_hosting_networks
:noindex:
:members: create_network, update_network, delete_network, get_network,
find_network, networks, get_network_ip_availability,
find_network_ip_availability, network_ip_availabilities,
add_dhcp_agent_to_network, remove_dhcp_agent_from_network,
dhcp_agent_hosting_networks,
Port Operations
^^^^^^^^^^^^^^^
.. autoclass:: openstack.network.v2._proxy.Proxy
.. automethod:: openstack.network.v2._proxy.Proxy.create_port
.. automethod:: openstack.network.v2._proxy.Proxy.create_ports
.. automethod:: openstack.network.v2._proxy.Proxy.update_port
.. automethod:: openstack.network.v2._proxy.Proxy.delete_port
.. automethod:: openstack.network.v2._proxy.Proxy.get_port
.. automethod:: openstack.network.v2._proxy.Proxy.find_port
.. automethod:: openstack.network.v2._proxy.Proxy.ports
.. automethod:: openstack.network.v2._proxy.Proxy.add_ip_to_port
.. automethod:: openstack.network.v2._proxy.Proxy.remove_ip_from_port
:noindex:
:members: create_port, create_ports, update_port, delete_port, get_port,
find_port, ports, add_ip_to_port, remove_ip_from_port
Router Operations
^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.network.v2._proxy.Proxy
.. automethod:: openstack.network.v2._proxy.Proxy.create_router
.. automethod:: openstack.network.v2._proxy.Proxy.update_router
.. automethod:: openstack.network.v2._proxy.Proxy.delete_router
.. automethod:: openstack.network.v2._proxy.Proxy.get_router
.. automethod:: openstack.network.v2._proxy.Proxy.find_router
.. automethod:: openstack.network.v2._proxy.Proxy.routers
.. automethod:: openstack.network.v2._proxy.Proxy.add_gateway_to_router
.. automethod:: openstack.network.v2._proxy.Proxy.remove_gateway_from_router
.. automethod:: openstack.network.v2._proxy.Proxy.add_interface_to_router
.. automethod:: openstack.network.v2._proxy.Proxy.remove_interface_from_router
.. automethod:: openstack.network.v2._proxy.Proxy.add_extra_routes_to_router
.. automethod:: openstack.network.v2._proxy.Proxy.remove_extra_routes_from_router
:noindex:
:members: create_router, update_router, delete_router, get_router,
find_router, routers,
add_gateway_to_router, remove_gateway_from_router,
add_interface_to_router, remove_interface_from_router,
add_extra_routes_to_router, remove_extra_routes_from_router
Floating IP Operations
^^^^^^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.network.v2._proxy.Proxy
.. automethod:: openstack.network.v2._proxy.Proxy.create_ip
.. automethod:: openstack.network.v2._proxy.Proxy.update_ip
.. automethod:: openstack.network.v2._proxy.Proxy.delete_ip
.. automethod:: openstack.network.v2._proxy.Proxy.get_ip
.. automethod:: openstack.network.v2._proxy.Proxy.find_ip
.. automethod:: openstack.network.v2._proxy.Proxy.find_available_ip
.. automethod:: openstack.network.v2._proxy.Proxy.ips
:noindex:
:members: create_ip, update_ip, delete_ip, get_ip, find_ip,
find_available_ip, ips
Pool Operations
^^^^^^^^^^^^^^^
.. autoclass:: openstack.network.v2._proxy.Proxy
.. automethod:: openstack.network.v2._proxy.Proxy.create_pool
.. automethod:: openstack.network.v2._proxy.Proxy.update_pool
.. automethod:: openstack.network.v2._proxy.Proxy.delete_pool
.. automethod:: openstack.network.v2._proxy.Proxy.get_pool
.. automethod:: openstack.network.v2._proxy.Proxy.find_pool
.. automethod:: openstack.network.v2._proxy.Proxy.pools
.. automethod:: openstack.network.v2._proxy.Proxy.create_pool_member
.. automethod:: openstack.network.v2._proxy.Proxy.update_pool_member
.. automethod:: openstack.network.v2._proxy.Proxy.delete_pool_member
.. automethod:: openstack.network.v2._proxy.Proxy.get_pool_member
.. automethod:: openstack.network.v2._proxy.Proxy.find_pool_member
.. automethod:: openstack.network.v2._proxy.Proxy.pool_members
:noindex:
:members: create_pool, update_pool, delete_pool, get_pool, find_pool, pools,
create_pool_member, update_pool_member, delete_pool_member,
get_pool_member, find_pool_member, pool_members
Auto Allocated Topology Operations
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.network.v2._proxy.Proxy
.. automethod:: openstack.network.v2._proxy.Proxy.delete_auto_allocated_topology
.. automethod:: openstack.network.v2._proxy.Proxy.get_auto_allocated_topology
.. automethod:: openstack.network.v2._proxy.Proxy.validate_auto_allocated_topology
:noindex:
:members: delete_auto_allocated_topology, get_auto_allocated_topology,
validate_auto_allocated_topology
Security Group Operations
^^^^^^^^^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.network.v2._proxy.Proxy
.. automethod:: openstack.network.v2._proxy.Proxy.create_security_group
.. automethod:: openstack.network.v2._proxy.Proxy.update_security_group
.. automethod:: openstack.network.v2._proxy.Proxy.delete_security_group
.. automethod:: openstack.network.v2._proxy.Proxy.get_security_group
.. automethod:: openstack.network.v2._proxy.Proxy.get_security_group_rule
.. automethod:: openstack.network.v2._proxy.Proxy.find_security_group
.. automethod:: openstack.network.v2._proxy.Proxy.find_security_group_rule
.. automethod:: openstack.network.v2._proxy.Proxy.security_group_rules
.. automethod:: openstack.network.v2._proxy.Proxy.security_groups
.. automethod:: openstack.network.v2._proxy.Proxy.create_security_group_rule
.. automethod:: openstack.network.v2._proxy.Proxy.create_security_group_rules
.. automethod:: openstack.network.v2._proxy.Proxy.delete_security_group_rule
:noindex:
:members: create_security_group, update_security_group,
delete_security_group, get_security_group,
get_security_group_rule, find_security_group,
find_security_group_rule, security_group_rules,
security_groups, create_security_group_rule,
create_security_group_rules, delete_security_group_rule
Availability Zone Operations
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.network.v2._proxy.Proxy
.. automethod:: openstack.network.v2._proxy.Proxy.availability_zones
:noindex:
:members: availability_zones
Address Scope Operations
^^^^^^^^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.network.v2._proxy.Proxy
.. automethod:: openstack.network.v2._proxy.Proxy.create_address_scope
.. automethod:: openstack.network.v2._proxy.Proxy.update_address_scope
.. automethod:: openstack.network.v2._proxy.Proxy.delete_address_scope
.. automethod:: openstack.network.v2._proxy.Proxy.get_address_scope
.. automethod:: openstack.network.v2._proxy.Proxy.find_address_scope
.. automethod:: openstack.network.v2._proxy.Proxy.address_scopes
:noindex:
:members: create_address_scope, update_address_scope, delete_address_scope,
get_address_scope, find_address_scope, address_scopes
Quota Operations
^^^^^^^^^^^^^^^^
.. autoclass:: openstack.network.v2._proxy.Proxy
.. automethod:: openstack.network.v2._proxy.Proxy.update_quota
.. automethod:: openstack.network.v2._proxy.Proxy.delete_quota
.. automethod:: openstack.network.v2._proxy.Proxy.get_quota
.. automethod:: openstack.network.v2._proxy.Proxy.get_quota_default
.. automethod:: openstack.network.v2._proxy.Proxy.quotas
:noindex:
:members: update_quota, delete_quota, get_quota, get_quota_default, quotas
QoS Operations
^^^^^^^^^^^^^^
.. autoclass:: openstack.network.v2._proxy.Proxy
.. automethod:: openstack.network.v2._proxy.Proxy.create_qos_policy
.. automethod:: openstack.network.v2._proxy.Proxy.update_qos_policy
.. automethod:: openstack.network.v2._proxy.Proxy.delete_qos_policy
.. automethod:: openstack.network.v2._proxy.Proxy.get_qos_policy
.. automethod:: openstack.network.v2._proxy.Proxy.find_qos_policy
.. automethod:: openstack.network.v2._proxy.Proxy.qos_policies
.. automethod:: openstack.network.v2._proxy.Proxy.get_qos_rule_type
.. automethod:: openstack.network.v2._proxy.Proxy.find_qos_rule_type
.. automethod:: openstack.network.v2._proxy.Proxy.qos_rule_types
.. automethod:: openstack.network.v2._proxy.Proxy.create_qos_minimum_bandwidth_rule
.. automethod:: openstack.network.v2._proxy.Proxy.update_qos_minimum_bandwidth_rule
.. automethod:: openstack.network.v2._proxy.Proxy.delete_qos_minimum_bandwidth_rule
.. automethod:: openstack.network.v2._proxy.Proxy.get_qos_minimum_bandwidth_rule
.. automethod:: openstack.network.v2._proxy.Proxy.find_qos_minimum_bandwidth_rule
.. automethod:: openstack.network.v2._proxy.Proxy.qos_minimum_bandwidth_rules
.. automethod:: openstack.network.v2._proxy.Proxy.create_qos_bandwidth_limit_rule
.. automethod:: openstack.network.v2._proxy.Proxy.update_qos_bandwidth_limit_rule
.. automethod:: openstack.network.v2._proxy.Proxy.delete_qos_bandwidth_limit_rule
.. automethod:: openstack.network.v2._proxy.Proxy.get_qos_bandwidth_limit_rule
.. automethod:: openstack.network.v2._proxy.Proxy.find_qos_bandwidth_limit_rule
.. automethod:: openstack.network.v2._proxy.Proxy.qos_bandwidth_limit_rules
.. automethod:: openstack.network.v2._proxy.Proxy.create_qos_dscp_marking_rule
.. automethod:: openstack.network.v2._proxy.Proxy.update_qos_dscp_marking_rule
.. automethod:: openstack.network.v2._proxy.Proxy.delete_qos_dscp_marking_rule
.. automethod:: openstack.network.v2._proxy.Proxy.get_qos_dscp_marking_rule
.. automethod:: openstack.network.v2._proxy.Proxy.find_qos_dscp_marking_rule
.. automethod:: openstack.network.v2._proxy.Proxy.qos_dscp_marking_rules
:noindex:
:members: create_qos_policy, update_qos_policy, delete_qos_policy,
get_qos_policy, find_qos_policy, qos_policies, get_qos_rule_type,
find_qos_rule_type, qos_rule_types,
create_qos_minimum_bandwidth_rule,
update_qos_minimum_bandwidth_rule,
delete_qos_minimum_bandwidth_rule,
get_qos_minimum_bandwidth_rule,
find_qos_minimum_bandwidth_rule,
qos_minimum_bandwidth_rules,
create_qos_bandwidth_limit_rule,
update_qos_bandwidth_limit_rule,
delete_qos_bandwidth_limit_rule,
get_qos_bandwidth_limit_rule, find_qos_bandwidth_limit_rule,
qos_bandwidth_limit_rules,
create_qos_dscp_marking_rule, update_qos_dscp_marking_rule,
delete_qos_dscp_marking_rule, get_qos_dscp_marking_rule,
find_qos_dscp_marking_rule, qos_dscp_marking_rules
Agent Operations
^^^^^^^^^^^^^^^^
.. autoclass:: openstack.network.v2._proxy.Proxy
.. automethod:: openstack.network.v2._proxy.Proxy.delete_agent
.. automethod:: openstack.network.v2._proxy.Proxy.update_agent
.. automethod:: openstack.network.v2._proxy.Proxy.get_agent
.. automethod:: openstack.network.v2._proxy.Proxy.agents
.. automethod:: openstack.network.v2._proxy.Proxy.agent_hosted_routers
.. automethod:: openstack.network.v2._proxy.Proxy.routers_hosting_l3_agents
.. automethod:: openstack.network.v2._proxy.Proxy.network_hosting_dhcp_agents
.. automethod:: openstack.network.v2._proxy.Proxy.add_router_to_agent
.. automethod:: openstack.network.v2._proxy.Proxy.remove_router_from_agent
:noindex:
:members: delete_agent, update_agent, get_agent, agents,
agent_hosted_routers, routers_hosting_l3_agents,
network_hosting_dhcp_agents, add_router_to_agent,
remove_router_from_agent
RBAC Operations
^^^^^^^^^^^^^^^
.. autoclass:: openstack.network.v2._proxy.Proxy
.. automethod:: openstack.network.v2._proxy.Proxy.create_rbac_policy
.. automethod:: openstack.network.v2._proxy.Proxy.update_rbac_policy
.. automethod:: openstack.network.v2._proxy.Proxy.delete_rbac_policy
.. automethod:: openstack.network.v2._proxy.Proxy.get_rbac_policy
.. automethod:: openstack.network.v2._proxy.Proxy.find_rbac_policy
.. automethod:: openstack.network.v2._proxy.Proxy.rbac_policies
:noindex:
:members: create_rbac_policy, update_rbac_policy, delete_rbac_policy,
get_rbac_policy, find_rbac_policy, rbac_policies
Listener Operations
^^^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.network.v2._proxy.Proxy
.. automethod:: openstack.network.v2._proxy.Proxy.create_listener
.. automethod:: openstack.network.v2._proxy.Proxy.update_listener
.. automethod:: openstack.network.v2._proxy.Proxy.delete_listener
.. automethod:: openstack.network.v2._proxy.Proxy.get_listener
.. automethod:: openstack.network.v2._proxy.Proxy.find_listener
.. automethod:: openstack.network.v2._proxy.Proxy.listeners
:noindex:
:members: create_listener, update_listener, delete_listener,
get_listener, find_listener, listeners
Subnet Operations
^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.network.v2._proxy.Proxy
.. automethod:: openstack.network.v2._proxy.Proxy.create_subnet
.. automethod:: openstack.network.v2._proxy.Proxy.update_subnet
.. automethod:: openstack.network.v2._proxy.Proxy.delete_subnet
.. automethod:: openstack.network.v2._proxy.Proxy.get_subnet
.. automethod:: openstack.network.v2._proxy.Proxy.get_subnet_ports
.. automethod:: openstack.network.v2._proxy.Proxy.find_subnet
.. automethod:: openstack.network.v2._proxy.Proxy.subnets
.. automethod:: openstack.network.v2._proxy.Proxy.create_subnet_pool
.. automethod:: openstack.network.v2._proxy.Proxy.update_subnet_pool
.. automethod:: openstack.network.v2._proxy.Proxy.delete_subnet_pool
.. automethod:: openstack.network.v2._proxy.Proxy.get_subnet_pool
.. automethod:: openstack.network.v2._proxy.Proxy.find_subnet_pool
.. automethod:: openstack.network.v2._proxy.Proxy.subnet_pools
:noindex:
:members: create_subnet, update_subnet, delete_subnet, get_subnet,
get_subnet_ports, find_subnet, subnets, create_subnet_pool,
update_subnet_pool, delete_subnet_pool, get_subnet_pool,
find_subnet_pool, subnet_pools
Load Balancer Operations
^^^^^^^^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.network.v2._proxy.Proxy
.. automethod:: openstack.network.v2._proxy.Proxy.create_load_balancer
.. automethod:: openstack.network.v2._proxy.Proxy.update_load_balancer
.. automethod:: openstack.network.v2._proxy.Proxy.delete_load_balancer
.. automethod:: openstack.network.v2._proxy.Proxy.get_load_balancer
.. automethod:: openstack.network.v2._proxy.Proxy.find_load_balancer
.. automethod:: openstack.network.v2._proxy.Proxy.load_balancers
:noindex:
:members: create_load_balancer, update_load_balancer, delete_load_balancer,
get_load_balancer, find_load_balancer, load_balancers
Health Monitor Operations
^^^^^^^^^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.network.v2._proxy.Proxy
.. automethod:: openstack.network.v2._proxy.Proxy.create_health_monitor
.. automethod:: openstack.network.v2._proxy.Proxy.update_health_monitor
.. automethod:: openstack.network.v2._proxy.Proxy.delete_health_monitor
.. automethod:: openstack.network.v2._proxy.Proxy.get_health_monitor
.. automethod:: openstack.network.v2._proxy.Proxy.find_health_monitor
.. automethod:: openstack.network.v2._proxy.Proxy.health_monitors
:noindex:
:members: create_health_monitor, update_health_monitor,
delete_health_monitor, get_health_monitor, find_health_monitor,
health_monitors
Metering Label Operations
^^^^^^^^^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.network.v2._proxy.Proxy
.. automethod:: openstack.network.v2._proxy.Proxy.create_metering_label
.. automethod:: openstack.network.v2._proxy.Proxy.update_metering_label
.. automethod:: openstack.network.v2._proxy.Proxy.delete_metering_label
.. automethod:: openstack.network.v2._proxy.Proxy.get_metering_label
.. automethod:: openstack.network.v2._proxy.Proxy.find_metering_label
.. automethod:: openstack.network.v2._proxy.Proxy.metering_labels
.. automethod:: openstack.network.v2._proxy.Proxy.create_metering_label_rule
.. automethod:: openstack.network.v2._proxy.Proxy.update_metering_label_rule
.. automethod:: openstack.network.v2._proxy.Proxy.delete_metering_label_rule
.. automethod:: openstack.network.v2._proxy.Proxy.get_metering_label_rule
.. automethod:: openstack.network.v2._proxy.Proxy.find_metering_label_rule
.. automethod:: openstack.network.v2._proxy.Proxy.metering_label_rules
:noindex:
:members: create_metering_label, update_metering_label,
delete_metering_label, get_metering_label, find_metering_label,
metering_labels, create_metering_label_rule,
update_metering_label_rule, delete_metering_label_rule,
get_metering_label_rule, find_metering_label_rule,
metering_label_rules
Segment Operations
^^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.network.v2._proxy.Proxy
.. automethod:: openstack.network.v2._proxy.Proxy.create_segment
.. automethod:: openstack.network.v2._proxy.Proxy.update_segment
.. automethod:: openstack.network.v2._proxy.Proxy.delete_segment
.. automethod:: openstack.network.v2._proxy.Proxy.get_segment
.. automethod:: openstack.network.v2._proxy.Proxy.find_segment
.. automethod:: openstack.network.v2._proxy.Proxy.segments
:noindex:
:members: create_segment, update_segment, delete_segment, get_segment,
find_segment, segments
Flavor Operations
^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.network.v2._proxy.Proxy
.. automethod:: openstack.network.v2._proxy.Proxy.create_flavor
.. automethod:: openstack.network.v2._proxy.Proxy.update_flavor
.. automethod:: openstack.network.v2._proxy.Proxy.delete_flavor
.. automethod:: openstack.network.v2._proxy.Proxy.get_flavor
.. automethod:: openstack.network.v2._proxy.Proxy.find_flavor
.. automethod:: openstack.network.v2._proxy.Proxy.flavors
:noindex:
:members: create_flavor, update_flavor, delete_flavor, get_flavor,
find_flavor, flavors
Service Profile Operations
^^^^^^^^^^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.network.v2._proxy.Proxy
.. automethod:: openstack.network.v2._proxy.Proxy.create_service_profile
.. automethod:: openstack.network.v2._proxy.Proxy.update_service_profile
.. automethod:: openstack.network.v2._proxy.Proxy.delete_service_profile
.. automethod:: openstack.network.v2._proxy.Proxy.get_service_profile
.. automethod:: openstack.network.v2._proxy.Proxy.find_service_profile
.. automethod:: openstack.network.v2._proxy.Proxy.service_profiles
.. automethod:: openstack.network.v2._proxy.Proxy.associate_flavor_with_service_profile
.. automethod:: openstack.network.v2._proxy.Proxy.disassociate_flavor_from_service_profile
:noindex:
:members: create_service_profile, update_service_profile,
delete_service_profile, get_service_profile, find_service_profile,
service_profiles, associate_flavor_with_service_profile,
disassociate_flavor_from_service_profile
Tag Operations
^^^^^^^^^^^^^^
.. autoclass:: openstack.network.v2._proxy.Proxy
.. automethod:: openstack.network.v2._proxy.Proxy.set_tags
:noindex:
:members: set_tags
VPN Operations
^^^^^^^^^^^^^^
.. autoclass:: openstack.network.v2._proxy.Proxy
.. automethod:: openstack.network.v2._proxy.Proxy.create_vpn_service
.. automethod:: openstack.network.v2._proxy.Proxy.update_vpn_service
.. automethod:: openstack.network.v2._proxy.Proxy.delete_vpn_service
.. automethod:: openstack.network.v2._proxy.Proxy.get_vpn_service
.. automethod:: openstack.network.v2._proxy.Proxy.find_vpn_service
.. automethod:: openstack.network.v2._proxy.Proxy.vpn_services
:noindex:
:members: create_vpn_service, update_vpn_service, delete_vpn_service,
get_vpn_service, find_vpn_service, vpn_services
Extension Operations
^^^^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.network.v2._proxy.Proxy
.. automethod:: openstack.network.v2._proxy.Proxy.find_extension
.. automethod:: openstack.network.v2._proxy.Proxy.extensions
:noindex:
:members: find_extension, extensions
Service Provider Operations
^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.network.v2._proxy.Proxy
.. automethod:: openstack.network.v2._proxy.Proxy.service_providers
:noindex:
:members: service_providers

33
doc/source/user/proxies/object_store.rst
View File

@@ -15,36 +15,23 @@ Account Operations
^^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.object_store.v1._proxy.Proxy
.. automethod:: openstack.object_store.v1._proxy.Proxy.get_account_metadata
.. automethod:: openstack.object_store.v1._proxy.Proxy.set_account_metadata
.. automethod:: openstack.object_store.v1._proxy.Proxy.delete_account_metadata
:noindex:
:members: get_account_metadata, set_account_metadata, delete_account_metadata
Container Operations
^^^^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.object_store.v1._proxy.Proxy
.. automethod:: openstack.object_store.v1._proxy.Proxy.create_container
.. automethod:: openstack.object_store.v1._proxy.Proxy.delete_container
.. automethod:: openstack.object_store.v1._proxy.Proxy.containers
.. automethod:: openstack.object_store.v1._proxy.Proxy.get_container_metadata
.. automethod:: openstack.object_store.v1._proxy.Proxy.set_container_metadata
.. automethod:: openstack.object_store.v1._proxy.Proxy.delete_container_metadata
:noindex:
:members: create_container, delete_container, containers,
get_container_metadata, set_container_metadata,
delete_container_metadata
Object Operations
^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.object_store.v1._proxy.Proxy
.. automethod:: openstack.object_store.v1._proxy.Proxy.upload_object
.. automethod:: openstack.object_store.v1._proxy.Proxy.download_object
.. automethod:: openstack.object_store.v1._proxy.Proxy.copy_object
.. automethod:: openstack.object_store.v1._proxy.Proxy.delete_object
.. automethod:: openstack.object_store.v1._proxy.Proxy.get_object
.. automethod:: openstack.object_store.v1._proxy.Proxy.objects
.. automethod:: openstack.object_store.v1._proxy.Proxy.get_object_metadata
.. automethod:: openstack.object_store.v1._proxy.Proxy.set_object_metadata
.. automethod:: openstack.object_store.v1._proxy.Proxy.delete_object_metadata
:noindex:
:members: upload_object, download_object, copy_object, delete_object,
get_object, objects, get_object_metadata, set_object_metadata,
delete_object_metadata

35
doc/source/user/proxies/orchestration.rst
View File

@@ -17,37 +17,24 @@ Stack Operations
^^^^^^^^^^^^^^^^
.. autoclass:: openstack.orchestration.v1._proxy.Proxy
.. automethod:: openstack.orchestration.v1._proxy.Proxy.create_stack
.. automethod:: openstack.orchestration.v1._proxy.Proxy.check_stack
.. automethod:: openstack.orchestration.v1._proxy.Proxy.update_stack
.. automethod:: openstack.orchestration.v1._proxy.Proxy.delete_stack
.. automethod:: openstack.orchestration.v1._proxy.Proxy.find_stack
.. automethod:: openstack.orchestration.v1._proxy.Proxy.get_stack
.. automethod:: openstack.orchestration.v1._proxy.Proxy.get_stack_environment
.. automethod:: openstack.orchestration.v1._proxy.Proxy.get_stack_files
.. automethod:: openstack.orchestration.v1._proxy.Proxy.get_stack_template
.. automethod:: openstack.orchestration.v1._proxy.Proxy.stacks
.. automethod:: openstack.orchestration.v1._proxy.Proxy.validate_template
.. automethod:: openstack.orchestration.v1._proxy.Proxy.resources
:noindex:
:members: create_stack, check_stack, update_stack, delete_stack, find_stack,
get_stack, get_stack_environment, get_stack_files,
get_stack_template, stacks, validate_template, resources
Software Configuration Operations
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.orchestration.v1._proxy.Proxy
.. automethod:: openstack.orchestration.v1._proxy.Proxy.create_software_config
.. automethod:: openstack.orchestration.v1._proxy.Proxy.delete_software_config
.. automethod:: openstack.orchestration.v1._proxy.Proxy.get_software_config
.. automethod:: openstack.orchestration.v1._proxy.Proxy.software_configs
:noindex:
:members: create_software_config, delete_software_config,
get_software_config, software_configs
Software Deployment Operations
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.orchestration.v1._proxy.Proxy
.. automethod:: openstack.orchestration.v1._proxy.Proxy.create_software_deployment
.. automethod:: openstack.orchestration.v1._proxy.Proxy.update_software_deployment
.. automethod:: openstack.orchestration.v1._proxy.Proxy.delete_software_deployment
.. automethod:: openstack.orchestration.v1._proxy.Proxy.get_software_deployment
.. automethod:: openstack.orchestration.v1._proxy.Proxy.software_deployments
:noindex:
:members: create_software_deployment, update_software_deployment,
delete_software_deployment, get_software_deployment,
software_deployments

18
doc/source/user/proxies/workflow.rst
View File

@@ -14,20 +14,14 @@ Workflow Operations
^^^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.workflow.v2._proxy.Proxy
.. automethod:: openstack.workflow.v2._proxy.Proxy.create_workflow
.. automethod:: openstack.workflow.v2._proxy.Proxy.delete_workflow
.. automethod:: openstack.workflow.v2._proxy.Proxy.get_workflow
.. automethod:: openstack.workflow.v2._proxy.Proxy.find_workflow
.. automethod:: openstack.workflow.v2._proxy.Proxy.workflows
:noindex:
:members: create_workflow, delete_workflow, get_workflow,
find_workflow, workflows
Execution Operations
^^^^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.workflow.v2._proxy.Proxy
.. automethod:: openstack.workflow.v2._proxy.Proxy.create_execution
.. automethod:: openstack.workflow.v2._proxy.Proxy.delete_execution
.. automethod:: openstack.workflow.v2._proxy.Proxy.get_execution
.. automethod:: openstack.workflow.v2._proxy.Proxy.find_execution
.. automethod:: openstack.workflow.v2._proxy.Proxy.executions
:noindex:
:members: create_execution, delete_execution, get_execution,
find_execution, executions