import "github.com/rackspace/gophercloud/openstack"
auth_env.go client.go endpoint_location.go
var (
ErrNoAuthURL = fmt.Errorf("Environment variable OS_AUTH_URL needs to be set.")
ErrNoUsername = fmt.Errorf("Environment variable OS_USERNAME, OS_USERID, or OS_TOKEN needs to be set.")
ErrNoPassword = fmt.Errorf("Environment variable OS_PASSWORD or OS_TOKEN needs to be set.")
)ErrNoAuthUrl, ErrNoUsername, and ErrNoPassword errors indicate of the required OS_AUTH_URL, OS_USERNAME, or OS_PASSWORD environment variables, respectively, remain undefined. See the AuthOptions() function for more details.
func AuthOptionsFromEnv() (gophercloud.AuthOptions, error)
AuthOptionsFromEnv fills out an AuthOptions structure from the environment variables: OS_AUTH_URL, OS_USERNAME, OS_USERID, OS_PASSWORD, OS_TENANT_ID, OS_TENANT_NAME, OS_DOMAIN_ID, OS_DOMAIN_NAME, OS_TOKEN. It checks that (1) OS_AUTH_URL is set, (2) OS_USERNAME, OS_USERID, or OS_TOKEN is set, (3) OS_PASSWORD or OS_TOKEN is set.
func Authenticate(client *gophercloud.ProviderClient, options gophercloud.AuthOptions) error
Authenticate or re-authenticate against the most recent identity service supported at the provided endpoint.
func AuthenticateV2(client *gophercloud.ProviderClient, options gophercloud.AuthOptions) error
AuthenticateV2 explicitly authenticates against the identity v2 endpoint.
func AuthenticateV3(client *gophercloud.ProviderClient, options gophercloud.AuthOptions) error
AuthenticateV3 explicitly authenticates against the identity v3 service.
func AuthenticatedClient(options gophercloud.AuthOptions) (*gophercloud.ProviderClient, error)
AuthenticatedClient logs in to an OpenStack cloud found at the identity endpoint specified by options, acquires a token, and returns a Client instance that's ready to operate. It first queries the root identity endpoint to determine which versions of the identity service are supported, then chooses the most recent identity service available to proceed.
func NewBlockStorageV1(client *gophercloud.ProviderClient, eo gophercloud.EndpointOpts) (*gophercloud.ServiceClient, error)
NewBlockStorageV1 creates a ServiceClient that may be used to access the v1 block storage service.
func NewBlockStorageV2(client *gophercloud.ProviderClient, eo gophercloud.EndpointOpts) (*gophercloud.ServiceClient, error)
NewBlockStorageV2 creates a ServiceClient that may be used to access the v2 block storage service.
func NewCDNV1(client *gophercloud.ProviderClient, eo gophercloud.EndpointOpts) (*gophercloud.ServiceClient, error)
NewCDNV1 creates a ServiceClient that may be used to access the OpenStack v1 CDN service.
func NewClient(endpoint string) (*gophercloud.ProviderClient, error)
NewClient prepares an unauthenticated ProviderClient instance. Most users will probably prefer using the AuthenticatedClient function instead. This is useful if you wish to explicitly control the version of the identity service that's used for authentication explicitly, for example.
func NewComputeV2(client *gophercloud.ProviderClient, eo gophercloud.EndpointOpts) (*gophercloud.ServiceClient, error)
NewComputeV2 creates a ServiceClient that may be used with the v2 compute package.
func NewDBV1(client *gophercloud.ProviderClient, eo gophercloud.EndpointOpts) (*gophercloud.ServiceClient, error)
NewDBV1 creates a ServiceClient that may be used to access the v1 DB service.
func NewIdentityAdminV2(client *gophercloud.ProviderClient, eo gophercloud.EndpointOpts) (*gophercloud.ServiceClient, error)
func NewIdentityAdminV3(client *gophercloud.ProviderClient, eo gophercloud.EndpointOpts) (*gophercloud.ServiceClient, error)
func NewIdentityV2(client *gophercloud.ProviderClient) *gophercloud.ServiceClient
NewIdentityV2 creates a ServiceClient that may be used to interact with the v2 identity service.
func NewIdentityV3(client *gophercloud.ProviderClient) *gophercloud.ServiceClient
NewIdentityV3 creates a ServiceClient that may be used to access the v3 identity service.
func NewImageServiceV2(client *gophercloud.ProviderClient, eo gophercloud.EndpointOpts) (*gophercloud.ServiceClient, error)
NewImageServiceV2 creates a ServiceClient that may be used to access the v2 image service.
func NewNetworkV2(client *gophercloud.ProviderClient, eo gophercloud.EndpointOpts) (*gophercloud.ServiceClient, error)
NewNetworkV2 creates a ServiceClient that may be used with the v2 network package.
func NewObjectStorageV1(client *gophercloud.ProviderClient, eo gophercloud.EndpointOpts) (*gophercloud.ServiceClient, error)
NewObjectStorageV1 creates a ServiceClient that may be used with the v1 object storage package.
func NewOrchestrationV1(client *gophercloud.ProviderClient, eo gophercloud.EndpointOpts) (*gophercloud.ServiceClient, error)
NewOrchestrationV1 creates a ServiceClient that may be used to access the v1 orchestration service.
func NewTelemetryV2(client *gophercloud.ProviderClient, eo gophercloud.EndpointOpts) (*gophercloud.ServiceClient, error)
NewTelemetryV2 creates a ServiceClient that may be used to access the v2 telemetry service.
func V2EndpointURL(catalog *tokens2.ServiceCatalog, opts gophercloud.EndpointOpts) (string, error)
V2EndpointURL discovers the endpoint URL for a specific service from a ServiceCatalog acquired during the v2 identity service. The specified EndpointOpts are used to identify a unique, unambiguous endpoint to return. It's an error both when multiple endpoints match the provided criteria and when none do. The minimum that can be specified is a Type, but you will also often need to specify a Name and/or a Region depending on what's available on your OpenStack deployment.
func V3EndpointURL(catalog *tokens3.ServiceCatalog, opts gophercloud.EndpointOpts) (string, error)
V3EndpointURL discovers the endpoint URL for a specific service from a Catalog acquired during the v3 identity service. The specified EndpointOpts are used to identify a unique, unambiguous endpoint to return. It's an error both when multiple endpoints match the provided criteria and when none do. The minimum that can be specified is a Type, but you will also often need to specify a Name and/or a Region depending on what's available on your OpenStack deployment.
| Path | Synopsis |
|---|---|
| blockstorage/v1/apiversions | Package apiversions provides information and interaction with the different API versions for the OpenStack Block Storage service, code-named Cinder. |
| blockstorage/v1/snapshots | Package snapshots provides information and interaction with snapshots in the OpenStack Block Storage service. |
| blockstorage/v1/volumes | Package volumes provides information and interaction with volumes in the OpenStack Block Storage service. |
| blockstorage/v1/volumes/testing | This is package created is to hold fixtures (which imports testing), so that importing volumes package does not inadvertently import testing into production code More information here: https://github.com/rackspace/gophercloud/issues/473 |
| blockstorage/v1/volumetypes | Package volumetypes provides information and interaction with volume types in the OpenStack Block Storage service. |
| blockstorage/v2/extensions/volumeactions | Package volumeactions provides information and interaction with volumes in the OpenStack Block Storage service. |
| blockstorage/v2/volumes | Package volumes provides information and interaction with volumes in the OpenStack Block Storage service. |
| cdn/v1/base | Package base provides information and interaction with the base API resource in the OpenStack CDN service. |
| cdn/v1/flavors | Package flavors provides information and interaction with the flavors API resource in the OpenStack CDN service. |
| cdn/v1/serviceassets | Package serviceassets provides information and interaction with the serviceassets API resource in the OpenStack CDN service. |
| cdn/v1/services | Package services provides information and interaction with the services API resource in the OpenStack CDN service. |
| common/extensions | Package extensions provides information and interaction with the different extensions available for an OpenStack service. |
| compute/v2/extensions | Package extensions provides information and interaction with the different extensions available for the OpenStack Compute service. |
| compute/v2/extensions/adminactions | Package provides access to the "Admin Actions" of the Compute API, including migrations, live-migrations, reset-state, etc. |
| compute/v2/extensions/bootfromvolume | |
| compute/v2/extensions/defsecrules | |
| compute/v2/extensions/diskconfig | Package diskconfig provides information and interaction with the Disk Config extension that works with the OpenStack Compute service. |
| compute/v2/extensions/floatingip | Package floatingip provides the ability to manage floating ips through nova-network |
| compute/v2/extensions/keypairs | Package keypairs provides information and interaction with the Keypairs extension for the OpenStack Compute service. |
| compute/v2/extensions/networks | Package network provides the ability to manage nova-networks |
| compute/v2/extensions/quotasets | Package quotasets provides information and interaction with QuotaSet extension for the OpenStack Compute service. |
| compute/v2/extensions/schedulerhints | Package schedulerhints enables instances to provide the OpenStack scheduler hints about where they should be placed in the cloud. |
| compute/v2/extensions/secgroups | |
| compute/v2/extensions/servergroups | Package servergroups provides the ability to manage server groups |
| compute/v2/extensions/startstop | Package startstop provides functionality to start and stop servers that have been provisioned by the OpenStack Compute service. |
| compute/v2/extensions/tenantnetworks | Package tenantnetworks provides the ability for tenants to see information about the networks they have access to |
| compute/v2/extensions/volumeattach | Package volumeattach provides the ability to attach and detach volumes to instances |
| compute/v2/extensions/volumeattach/testing | This is package created is to hold fixtures (which imports testing), so that importing volumeattach package does not inadvertently import testing into production code More information here: https://github.com/rackspace/gophercloud/issues/473 |
| compute/v2/flavors | Package flavors provides information and interaction with the flavor API resource in the OpenStack Compute service. |
| compute/v2/images | Package images provides information and interaction with the image API resource in the OpenStack Compute service. |
| compute/v2/servers | Package servers provides information and interaction with the server API resource in the OpenStack Compute service. |
| db/v1/configurations | Package configurations provides information and interaction with the configuration API resource in the Rackspace Database service. |
| db/v1/databases | Package flavors provides information and interaction with the database API resource in the OpenStack Database service. |
| db/v1/datastores | Package datastores provides information and interaction with the datastore API resource in the Rackspace Database service. |
| db/v1/flavors | Package flavors provides information and interaction with the flavor API resource in the OpenStack Database service. |
| db/v1/instances | Package instances provides information and interaction with the instance API resource in the OpenStack Database service. |
| db/v1/users | Package users provides information and interaction with the user API resource in the OpenStack Database service. |
| identity/v2/extensions | Package extensions provides information and interaction with the different extensions available for the OpenStack Identity service. |
| identity/v2/extensions/admin/roles | Package roles provides functionality to interact with and control roles on the API. |
| identity/v2/tenants | Package tenants provides information and interaction with the tenants API resource for the OpenStack Identity service. |
| identity/v2/tokens | Package tokens provides information and interaction with the token API resource for the OpenStack Identity service. |
| identity/v2/users | |
| identity/v3/endpoints | Package endpoints provides information and interaction with the service endpoints API resource in the OpenStack Identity service. |
| identity/v3/extensions | Package extensions provides information and interaction with the different extensions available for the OpenStack Identity v3 service. |
| identity/v3/extensions/trust | |
| identity/v3/roles | Package roles provides information and interaction with the roles API resource for the OpenStack Identity service. |
| identity/v3/services | Package services provides information and interaction with the services API resource for the OpenStack Identity service. |
| identity/v3/tokens | Package tokens provides information and interaction with the token API resource for the OpenStack Identity service. |
| imageservice/v2/images | |
| imageservice/v2/members | |
| networking/v2/apiversions | Package apiversions provides information and interaction with the different API versions for the OpenStack Neutron service. |
| networking/v2/common | |
| networking/v2/extensions | |
| networking/v2/extensions/external | Package external provides information and interaction with the external extension for the OpenStack Networking service. |
| networking/v2/extensions/fwaas | Package fwaas provides information and interaction with the Firewall as a Service extension for the OpenStack Networking service. |
| networking/v2/extensions/fwaas/firewalls | |
| networking/v2/extensions/fwaas/policies | |
| networking/v2/extensions/fwaas/rules | |
| networking/v2/extensions/layer3 | Package layer3 provides access to the Layer-3 networking extension for the OpenStack Neutron service. |
| networking/v2/extensions/layer3/floatingips | |
| networking/v2/extensions/layer3/routers | |
| networking/v2/extensions/lbaas | Package lbaas provides information and interaction with the Load Balancer as a Service extension for the OpenStack Networking service. |
| networking/v2/extensions/lbaas/members | |
| networking/v2/extensions/lbaas/monitors | |
| networking/v2/extensions/lbaas/pools | |
| networking/v2/extensions/lbaas_v2 | Package lbaas_v2 provides information and interaction with the Load Balancer as a Service v2 extension for the OpenStack Networking service. |
| networking/v2/extensions/lbaas_v2/listeners | |
| networking/v2/extensions/lbaas_v2/loadbalancers | |
| networking/v2/extensions/lbaas_v2/monitors | |
| networking/v2/extensions/lbaas_v2/pools | |
| networking/v2/extensions/lbaas/vips | |
| networking/v2/extensions/portsbinding | Package portsbinding provides information and interaction with the port binding extension for the OpenStack Networking service. |
| networking/v2/extensions/provider | Package provider gives access to the provider Neutron plugin, allowing network extended attributes. |
| networking/v2/extensions/security | Package security contains functionality to work with security group and security group rules Neutron resources. |
| networking/v2/extensions/security/groups | |
| networking/v2/extensions/security/rules | |
| networking/v2/networks | Package networks contains functionality for working with Neutron network resources. |
| networking/v2/ports | Package ports contains functionality for working with Neutron port resources. |
| networking/v2/subnets | Package subnets contains functionality for working with Neutron subnet resources. |
| objectstorage/v1/accounts | Package accounts contains functionality for working with Object Storage account resources. |
| objectstorage/v1/containers | Package containers contains functionality for working with Object Storage container resources. |
| objectstorage/v1/objects | Package objects contains functionality for working with Object Storage object resources. |
| orchestration/v1/apiversions | Package apiversions provides information and interaction with the different API versions for the OpenStack Heat service. |
| orchestration/v1/buildinfo | Package buildinfo provides build information about heat deployments. |
| orchestration/v1/stackevents | Package stackevents provides operations for finding, listing, and retrieving stack events. |
| orchestration/v1/stackresources | Package stackresources provides operations for working with stack resources. |
| orchestration/v1/stacks | Package stacks provides operation for working with Heat stacks. |
| orchestration/v1/stacktemplates | Package stacktemplates provides operations for working with Heat templates. |
| telemetry/v2/meters | |
| utils |
Package openstack imports 9 packages (graph) and is imported by 490 packages. Updated 2019-05-23. Refresh now. Tools for package owners.