securityservices

Documentation

Index

• func List(client *gophercloud.ServiceClient, opts ListOptsBuilder) pagination.Pager
• type CreateOpts
  • func (opts CreateOpts) ToSecurityServiceCreateMap() (map[string]interface{}, error)
• type CreateOptsBuilder
• type CreateResult
  • func Create(client *gophercloud.ServiceClient, opts CreateOptsBuilder) (r CreateResult)
  • func (r CreateResult) Extract() (*SecurityService, error)
• type DeleteResult
  • func Delete(client *gophercloud.ServiceClient, id string) (r DeleteResult)
• type GetResult
  • func Get(client *gophercloud.ServiceClient, id string) (r GetResult)
  • func (r GetResult) Extract() (*SecurityService, error)
• type ListOpts
  • func (opts ListOpts) ToSecurityServiceListQuery() (string, error)
• type ListOptsBuilder
• type SecurityService
  • func ExtractSecurityServices(r pagination.Page) ([]SecurityService, error)
  • func (r *SecurityService) UnmarshalJSON(b []byte) error
• type SecurityServicePage
  • func (r SecurityServicePage) IsEmpty() (bool, error)
• type SecurityServiceType
• type UpdateOpts
  • func (opts UpdateOpts) ToSecurityServiceUpdateMap() (map[string]interface{}, error)
• type UpdateOptsBuilder
• type UpdateResult
  • func Update(client *gophercloud.ServiceClient, id string, opts UpdateOptsBuilder) (r UpdateResult)
  • func (r UpdateResult) Extract() (*SecurityService, error)

Functions

func List

func List(client *gophercloud.ServiceClient, opts ListOptsBuilder) pagination.Pager

List returns SecurityServices optionally limited by the conditions provided in ListOpts.

Types

type CreateOpts

type CreateOpts struct {
	// The security service type. A valid value is ldap, kerberos, or active_directory
	Type SecurityServiceType `json:"type" required:"true"`
	// The security service name
	Name string `json:"name,omitempty"`
	// The security service description
	Description string `json:"description,omitempty"`
	// The DNS IP address that is used inside the tenant network
	DNSIP string `json:"dns_ip,omitempty"`
	// The security service organizational unit (OU). Minimum supported microversion for OU is 2.44.
	OU string `json:"ou,omitempty"`
	// The security service user or group name that is used by the tenant
	User string `json:"user,omitempty"`
	// The user password, if you specify a user
	Password string `json:"password,omitempty"`
	// The security service domain
	Domain string `json:"domain,omitempty"`
	// The security service host name or IP address
	Server string `json:"server,omitempty"`
}

CreateOpts contains options for creating a SecurityService. This object is passed to the securityservices.Create function. For more information about these parameters, see the SecurityService object.

func (CreateOpts) ToSecurityServiceCreateMap

func (opts CreateOpts) ToSecurityServiceCreateMap() (map[string]interface{}, error)

ToSecurityServicesCreateMap assembles a request body based on the contents of a CreateOpts.

type CreateOptsBuilder

type CreateOptsBuilder interface {
	ToSecurityServiceCreateMap() (map[string]interface{}, error)
}

CreateOptsBuilder allows extensions to add additional parameters to the Create request.

type CreateResult

type CreateResult struct {
	// contains filtered or unexported fields
}

CreateResult contains the response body and error from a Create request.

func Create

func Create(client *gophercloud.ServiceClient, opts CreateOptsBuilder) (r CreateResult)

Create will create a new SecurityService based on the values in CreateOpts. To extract the SecurityService object from the response, call the Extract method on the CreateResult.

func (CreateResult) Extract

func (r CreateResult) Extract() (*SecurityService, error)

Extract will get the SecurityService object out of the commonResult object.

type DeleteResult

type DeleteResult struct {
	gophercloud.ErrResult
}

DeleteResult contains the response body and error from a Delete request.

func Delete

func Delete(client *gophercloud.ServiceClient, id string) (r DeleteResult)

Delete will delete the existing SecurityService with the provided ID.

type GetResult

type GetResult struct {
	// contains filtered or unexported fields
}

GetResult contains the response body and error from a Get request.

func Get

func Get(client *gophercloud.ServiceClient, id string) (r GetResult)

Get retrieves the SecurityService with the provided ID. To extract the SecurityService object from the response, call the Extract method on the GetResult.

func (GetResult) Extract

func (r GetResult) Extract() (*SecurityService, error)

Extract will get the SecurityService object out of the commonResult object.

type ListOpts

type ListOpts struct {
	// admin-only option. Set it to true to see all tenant security services.
	AllTenants bool `q:"all_tenants"`
	// The security service ID
	ID string `q:"id"`
	// The security service domain
	Domain string `q:"domain"`
	// The security service type. A valid value is ldap, kerberos, or active_directory
	Type SecurityServiceType `q:"type"`
	// The security service name
	Name string `q:"name"`
	// The DNS IP address that is used inside the tenant network
	DNSIP string `q:"dns_ip"`
	// The security service organizational unit (OU). Minimum supported microversion for OU is 2.44.
	OU string `q:"ou"`
	// The security service user or group name that is used by the tenant
	User string `q:"user"`
	// The security service host name or IP address
	Server string `q:"server"`
	// The ID of the share network using security services
	ShareNetworkID string `q:"share_network_id"`
}

ListOpts holds options for listing SecurityServices. It is passed to the securityservices.List function.

func (ListOpts) ToSecurityServiceListQuery

func (opts ListOpts) ToSecurityServiceListQuery() (string, error)

ToSecurityServiceListQuery formats a ListOpts into a query string.

type ListOptsBuilder

type ListOptsBuilder interface {
	ToSecurityServiceListQuery() (string, error)
}

ListOptsBuilder allows extensions to add additional parameters to the List request.

type SecurityService

type SecurityService struct {
	// The security service ID
	ID string `json:"id"`
	// The UUID of the project where the security service was created
	ProjectID string `json:"project_id"`
	// The security service domain
	Domain string `json:"domain"`
	// The security service status
	Status string `json:"status"`
	// The security service type. A valid value is ldap, kerberos, or active_directory
	Type string `json:"type"`
	// The security service name
	Name string `json:"name"`
	// The security service description
	Description string `json:"description"`
	// The DNS IP address that is used inside the tenant network
	DNSIP string `json:"dns_ip"`
	// The security service organizational unit (OU)
	OU string `json:"ou"`
	// The security service user or group name that is used by the tenant
	User string `json:"user"`
	// The user password, if you specify a user
	Password string `json:"password"`
	// The security service host name or IP address
	Server string `json:"server"`
	// The date and time stamp when the security service was created
	CreatedAt time.Time `json:"-"`
	// The date and time stamp when the security service was updated
	UpdatedAt time.Time `json:"-"`
}

SecurityService contains all the information associated with an OpenStack SecurityService.

func ExtractSecurityServices

func ExtractSecurityServices(r pagination.Page) ([]SecurityService, error)

ExtractSecurityServices extracts and returns SecurityServices. It is used while iterating over a securityservices.List call.

func (*SecurityService) UnmarshalJSON

func (r *SecurityService) UnmarshalJSON(b []byte) error

type SecurityServicePage

type SecurityServicePage struct {
	pagination.SinglePageBase
}

SecurityServicePage is a pagination.pager that is returned from a call to the List function.

func (SecurityServicePage) IsEmpty

func (r SecurityServicePage) IsEmpty() (bool, error)

IsEmpty returns true if a ListResult contains no SecurityServices.

type SecurityServiceType

type SecurityServiceType string

const (
	LDAP            SecurityServiceType = "ldap"
	Kerberos        SecurityServiceType = "kerberos"
	ActiveDirectory SecurityServiceType = "active_directory"
)

Valid security service types

type UpdateOpts

type UpdateOpts struct {
	// The security service name
	Name *string `json:"name"`
	// The security service description
	Description *string `json:"description,omitempty"`
	// The security service type. A valid value is ldap, kerberos, or active_directory
	Type string `json:"type,omitempty"`
	// The DNS IP address that is used inside the tenant network
	DNSIP *string `json:"dns_ip,omitempty"`
	// The security service organizational unit (OU). Minimum supported microversion for OU is 2.44.
	OU *string `json:"ou,omitempty"`
	// The security service user or group name that is used by the tenant
	User *string `json:"user,omitempty"`
	// The user password, if you specify a user
	Password *string `json:"password,omitempty"`
	// The security service domain
	Domain *string `json:"domain,omitempty"`
	// The security service host name or IP address
	Server *string `json:"server,omitempty"`
}

UpdateOpts contain options for updating an existing SecurityService. This object is passed to the securityservices.Update function. For more information about the parameters, see the SecurityService object.

func (UpdateOpts) ToSecurityServiceUpdateMap

func (opts UpdateOpts) ToSecurityServiceUpdateMap() (map[string]interface{}, error)

ToSecurityServiceUpdateMap assembles a request body based on the contents of an UpdateOpts.

type UpdateOptsBuilder

type UpdateOptsBuilder interface {
	ToSecurityServiceUpdateMap() (map[string]interface{}, error)
}

UpdateOptsBuilder allows extensions to add additional parameters to the Update request.

type UpdateResult

type UpdateResult struct {
	// contains filtered or unexported fields
}

UpdateResult contains the response body and error from an Update request.

func Update

func Update(client *gophercloud.ServiceClient, id string, opts UpdateOptsBuilder) (r UpdateResult)

Update will update the SecurityService with provided information. To extract the updated SecurityService from the response, call the Extract method on the UpdateResult.

func (UpdateResult) Extract

func (r UpdateResult) Extract() (*SecurityService, error)

Extract will get the SecurityService object out of the commonResult object.