Documentation ¶
Overview ¶
Copyright 2019 Cohesity Inc.
Copyright 2019 Cohesity Inc.
Index ¶
- type ACTIVEDIRECTORY
- type ACTIVEDIRECTORY_IMPL
- func (me *ACTIVEDIRECTORY_IMPL) AddActiveDirectoryPrincipals(body []*models.ActiveDirectoryPrincipalsAddParameters) ([]*models.AddedActiveDirectoryPrincipal, error)
- func (me *ACTIVEDIRECTORY_IMPL) CreateActiveDirectoryEntry(body *models.CreateActiveDirectoryEntryParams) (*models.ActiveDirectoryEntry, error)
- func (me *ACTIVEDIRECTORY_IMPL) CreateEnableTrustedDomainDiscovery(trustedDomainsEnabled bool, name string) (*models.ActiveDirectoryEntry, error)
- func (me *ACTIVEDIRECTORY_IMPL) DeleteActiveDirectoryEntry(body *models.ActiveDirectoryEntry) error
- func (me *ACTIVEDIRECTORY_IMPL) GetActiveDirectoryDomainControllers() (*models.DomainControllers, error)
- func (me *ACTIVEDIRECTORY_IMPL) GetActiveDirectoryEntry(domains []string, tenantIds []string, allUnderHierarchy *bool) ([]*models.ActiveDirectoryEntry, error)
- func (me *ACTIVEDIRECTORY_IMPL) ListCentrifyZones(domainName *string) ([]*models.ListCentrifyZone, error)
- func (me *ACTIVEDIRECTORY_IMPL) SearchActiveDirectoryPrincipals(domain *string, ...) ([]*models.ActiveDirectoryPrincipal, error)
- func (me *ACTIVEDIRECTORY_IMPL) UpdateActiveDirectoryIdMapping(body *models.IdMappingInfo, name string) (*models.ActiveDirectoryEntry, error)
- func (me *ACTIVEDIRECTORY_IMPL) UpdateActiveDirectoryIgnoredTrustedDomains(body *models.UpdateIgnoredTrustedDomainsParams, name string) (*models.ActiveDirectoryEntry, error)
- func (me *ACTIVEDIRECTORY_IMPL) UpdateActiveDirectoryLdapProvider(body *models.UpdateLdapProviderParams, name string) (*models.ActiveDirectoryEntry, error)
- func (me *ACTIVEDIRECTORY_IMPL) UpdateActiveDirectoryMachineAccounts(body *models.UpdateMachineAccountsParams, name string) (*models.ActiveDirectoryEntry, error)
- func (me *ACTIVEDIRECTORY_IMPL) UpdatePreferredDomainControllers(body []*models.PreferredDomainController, name string) (*models.ActiveDirectoryEntry, error)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ACTIVEDIRECTORY ¶
type ACTIVEDIRECTORY interface { DeleteActiveDirectoryEntry(*models.ActiveDirectoryEntry) error GetActiveDirectoryEntry([]string, []string, *bool) ([]*models.ActiveDirectoryEntry, error) CreateActiveDirectoryEntry(*models.CreateActiveDirectoryEntryParams) (*models.ActiveDirectoryEntry, error) ListCentrifyZones(*string) ([]*models.ListCentrifyZone, error) GetActiveDirectoryDomainControllers() (*models.DomainControllers, error) SearchActiveDirectoryPrincipals(*string, models.ObjectClassSearchActiveDirectoryPrincipalsEnum, *string, []string, *bool) ([]*models.ActiveDirectoryPrincipal, error) AddActiveDirectoryPrincipals([]*models.ActiveDirectoryPrincipalsAddParameters) ([]*models.AddedActiveDirectoryPrincipal, error) CreateEnableTrustedDomainDiscovery(bool, string) (*models.ActiveDirectoryEntry, error) UpdateActiveDirectoryIdMapping(*models.IdMappingInfo, string) (*models.ActiveDirectoryEntry, error) UpdateActiveDirectoryIgnoredTrustedDomains(*models.UpdateIgnoredTrustedDomainsParams, string) (*models.ActiveDirectoryEntry, error) UpdateActiveDirectoryLdapProvider(*models.UpdateLdapProviderParams, string) (*models.ActiveDirectoryEntry, error) UpdateActiveDirectoryMachineAccounts(*models.UpdateMachineAccountsParams, string) (*models.ActiveDirectoryEntry, error) UpdatePreferredDomainControllers([]*models.PreferredDomainController, string) (*models.ActiveDirectoryEntry, error) }
* Interface for the ACTIVEDIRECTORY_IMPL
type ACTIVEDIRECTORY_IMPL ¶
type ACTIVEDIRECTORY_IMPL struct {
// contains filtered or unexported fields
}
* Client structure as interface implementation
func NewACTIVEDIRECTORY ¶
func NewACTIVEDIRECTORY(config configuration.CONFIGURATION) *ACTIVEDIRECTORY_IMPL
* Factory for the ACTIVEDIRECTORY interaface returning ACTIVEDIRECTORY_IMPL
func (*ACTIVEDIRECTORY_IMPL) AddActiveDirectoryPrincipals ¶
func (me *ACTIVEDIRECTORY_IMPL) AddActiveDirectoryPrincipals( body []*models.ActiveDirectoryPrincipalsAddParameters) ([]*models.AddedActiveDirectoryPrincipal, error)
*
- After a group or user has been added to a Cohesity Cluster,
- the referenced Active Directory principal can be used by the Cohesity Cluster.
- In addition, this operation maps Cohesity roles with a group or user and
- this mapping defines the privileges allowed on the Cohesity Cluster for the
- group or user.
- For example if an 'management' group is created on the Cohesity Cluster
- for the Active Directory 'management' principal group and is
- associated with the Cohesity 'View' role, all users in the
- referenced Active Directory 'management' principal group can log in to the
- Cohesity Dashboard but will only have view-only privileges.
- These users cannot create new Protection Jobs, Policies, Views, etc.
- NOTE: Local Cohesity users and groups cannot be created by this operation.
- Local Cohesity users or groups do not have an associated Active Directory
- principals and are created directly in the default LOCAL domain.
- @param []*models.ActiveDirectoryPrincipalsAddParameters body parameter: Optional
- @return Returns the []*models.AddedActiveDirectoryPrincipal response from the API call
func (*ACTIVEDIRECTORY_IMPL) CreateActiveDirectoryEntry ¶
func (me *ACTIVEDIRECTORY_IMPL) CreateActiveDirectoryEntry( body *models.CreateActiveDirectoryEntryParams) (*models.ActiveDirectoryEntry, error)
*
- After a Cohesity Cluster has been joined to an Active Directory domain,
- the users and groups in the domain can be authenticated on the Cohesity Cluster
- using their Active Directory credentials.
- @param *models.CreateActiveDirectoryEntryParams body parameter: Required
- @return Returns the *models.ActiveDirectoryEntry response from the API call
func (*ACTIVEDIRECTORY_IMPL) CreateEnableTrustedDomainDiscovery ¶
func (me *ACTIVEDIRECTORY_IMPL) CreateEnableTrustedDomainDiscovery( trustedDomainsEnabled bool, name string) (*models.ActiveDirectoryEntry, error)
*
- Updates the states of trusted domains discovery.
- @param bool trustedDomainsEnabled parameter: Required
- @param string name parameter: Required
- @return Returns the *models.ActiveDirectoryEntry response from the API call
func (*ACTIVEDIRECTORY_IMPL) DeleteActiveDirectoryEntry ¶
func (me *ACTIVEDIRECTORY_IMPL) DeleteActiveDirectoryEntry( body *models.ActiveDirectoryEntry) error
*
- Deletes the join of the Cohesity Cluster to the specified
- Active Directory domain. After the deletion, the Cohesity Cluster
- no longer has access to the principals on the Active Directory.
- For example, you can no longer log in to the Cohesity Cluster
- with a user defined in a principal group of the Active Directory domain.
- @param *models.ActiveDirectoryEntry body parameter: Required
- @return Returns the response from the API call
func (*ACTIVEDIRECTORY_IMPL) GetActiveDirectoryDomainControllers ¶
func (me *ACTIVEDIRECTORY_IMPL) GetActiveDirectoryDomainControllers() (*models.DomainControllers, error)
*
- List the domain controllers for a domain.
- @return Returns the *models.DomainControllers response from the API call
func (*ACTIVEDIRECTORY_IMPL) GetActiveDirectoryEntry ¶
func (me *ACTIVEDIRECTORY_IMPL) GetActiveDirectoryEntry( domains []string, tenantIds []string, allUnderHierarchy *bool) ([]*models.ActiveDirectoryEntry, error)
*
- After a Cohesity Cluster has been joined to an Active Directory domain,
- the users and groups in the domain can be authenticated on the Cohesity Cluster
- using their Active Directory credentials.
- NOTE: The userName and password fields are not populated by this operation.
- @param []string domains parameter: Optional
- @param []string tenantIds parameter: Optional
- @param *bool allUnderHierarchy parameter: Optional
- @return Returns the []*models.ActiveDirectoryEntry response from the API call
func (*ACTIVEDIRECTORY_IMPL) ListCentrifyZones ¶
func (me *ACTIVEDIRECTORY_IMPL) ListCentrifyZones( domainName *string) ([]*models.ListCentrifyZone, error)
*
- Fetches the list centrify zones of an active directory domain.
- @param *string domainName parameter: Optional
- @return Returns the []*models.ListCentrifyZone response from the API call
func (*ACTIVEDIRECTORY_IMPL) SearchActiveDirectoryPrincipals ¶
func (me *ACTIVEDIRECTORY_IMPL) SearchActiveDirectoryPrincipals( domain *string, objectClass models.ObjectClassSearchActiveDirectoryPrincipalsEnum, search *string, sids []string, includeComputers *bool) ([]*models.ActiveDirectoryPrincipal, error)
*
- Optionally limit the search results by specifying security identifiers (SIDs),
- an object class (user or group) or a substring.
- You can specify SIDs or a substring but not both.
- @param *string domain parameter: Optional
- @param models.ObjectClassSearchActiveDirectoryPrincipalsEnum objectClass parameter: Optional
- @param *string search parameter: Optional
- @param []string sids parameter: Optional
- @param *bool includeComputers parameter: Optional
- @return Returns the []*models.ActiveDirectoryPrincipal response from the API call
func (*ACTIVEDIRECTORY_IMPL) UpdateActiveDirectoryIdMapping ¶
func (me *ACTIVEDIRECTORY_IMPL) UpdateActiveDirectoryIdMapping( body *models.IdMappingInfo, name string) (*models.ActiveDirectoryEntry, error)
*
- Updates the user id mapping info of an Active Directory.
- @param *models.IdMappingInfo body parameter: Required
- @param string name parameter: Required
- @return Returns the *models.ActiveDirectoryEntry response from the API call
func (*ACTIVEDIRECTORY_IMPL) UpdateActiveDirectoryIgnoredTrustedDomains ¶
func (me *ACTIVEDIRECTORY_IMPL) UpdateActiveDirectoryIgnoredTrustedDomains( body *models.UpdateIgnoredTrustedDomainsParams, name string) (*models.ActiveDirectoryEntry, error)
*
- Updates the list of trusted domains to be ignored during trusted domain discovery of an Active Directory.
- @param *models.UpdateIgnoredTrustedDomainsParams body parameter: Required
- @param string name parameter: Required
- @return Returns the *models.ActiveDirectoryEntry response from the API call
func (*ACTIVEDIRECTORY_IMPL) UpdateActiveDirectoryLdapProvider ¶
func (me *ACTIVEDIRECTORY_IMPL) UpdateActiveDirectoryLdapProvider( body *models.UpdateLdapProviderParams, name string) (*models.ActiveDirectoryEntry, error)
*
- Updates the the LDAP provide Id for an Active Directory domain.
- @param *models.UpdateLdapProviderParams body parameter: Required
- @param string name parameter: Required
- @return Returns the *models.ActiveDirectoryEntry response from the API call
func (*ACTIVEDIRECTORY_IMPL) UpdateActiveDirectoryMachineAccounts ¶
func (me *ACTIVEDIRECTORY_IMPL) UpdateActiveDirectoryMachineAccounts( body *models.UpdateMachineAccountsParams, name string) (*models.ActiveDirectoryEntry, error)
*
- Updates the machine accounts of an Active Directory.
- @param *models.UpdateMachineAccountsParams body parameter: Required
- @param string name parameter: Required
- @return Returns the *models.ActiveDirectoryEntry response from the API call
func (*ACTIVEDIRECTORY_IMPL) UpdatePreferredDomainControllers ¶
func (me *ACTIVEDIRECTORY_IMPL) UpdatePreferredDomainControllers( body []*models.PreferredDomainController, name string) (*models.ActiveDirectoryEntry, error)
*
- Updates the preferred domain controllers of an Active Directory
- @param []*models.PreferredDomainController body parameter: Required
- @param string name parameter: Required
- @return Returns the *models.ActiveDirectoryEntry response from the API call
Click to show internal directories.
Click to hide internal directories.