[Index]

Model: data/activedirectoryhybrid

Active Directory

To access the latest documentation, go to Documentation and Resources at: https://voss.portalshape.com

Parameter Comments
Version The only version currently supported is 1.0.
Host Name The IP address or FQDN of the PS Proxy handling Active Directory connections.
Username The local service account created in the Remote Management Service Account section in General Help > Microsoft Configuration.
Password / Repeat The local service account's password.
Domain Name The domain portion of the domain service account's account name. We create this account in the Create the Domain Service Account section in General Help > Microsoft Configuration .
Domain Username The user name portion of the domain service account's account name created in the Create the Domain Service Account section in General Help > Microsoft Configuration.
Domain Password / Repeat The domain service account's password.
Active Directory Filter For example, a simple wildcard '*' filters nothing - all results are returned.
Active Directory SearchBase This is the Distinguished Name of the Organizational Unit containing the users and contacts that VOSS Automate will manage. Note that this is the OU for which we granted write privileges to the domain service account in the Grant Access to the Users' OU section.

Stores the connection parameters of an Active Directory Hybrid instance.

Model Details: data/activedirectoryhybrid

Title Description Details
Version *
  • Field Name: version
  • Type: String
  • Choices: ["Windows Server 2012 R2"]
Host Name *
  • Field Name: host
  • Type: String
Username *
  • Field Name: username
  • Type: String
Password *
  • Field Name: password
  • Type: String
  • Is Password: True
  • Store Encrypted: True
Domain Name *
  • Field Name: domain_name
  • Type: String
Domain Username *
  • Field Name: domain_username
  • Type: String
Domain Password *
  • Field Name: domain_password
  • Type: String
  • Is Password: True
  • Store Encrypted: True
Active Directory Filter * Default: *
  • Field Name: active_directory_filter
  • Type: String
  • Default: *
Active Directory SearchBase
  • Field Name: active_directory_searchbase
  • Type: String
Reuse Sessions If enabled, Powershell sessions will be re-used if possible, Default: True
  • Field Name: reuse_sessions
  • Type: Boolean
  • Default: True
Model Relation Mapping
  • Field Name: model_relation_mapping
  • Type: Object
Mappings
  • Field Name: mappings.[n]
  • Type: Array
Model From Default: string
  • Field Name: model_relation_mapping.mappings.[n].model_from
  • Type: String
  • Default: string
Model From Attribute Default: string
  • Field Name: model_relation_mapping.mappings.[n].model_from_attribute
  • Type: String
  • Default: string
Model To Default: string
  • Field Name: model_relation_mapping.mappings.[n].model_to
  • Type: String
  • Default: string
Model To Target Attribute Default: string
  • Field Name: model_relation_mapping.mappings.[n].model_to_target_attribute
  • Type: String
  • Default: string
Model To Display Attribute Default: string
  • Field Name: model_relation_mapping.mappings.[n].model_to_display_attribute
  • Type: String
  • Default: string