8.1 Add-DRAContact

Synopsis

Adds a contact object to an Active Directory domain.

Syntax

Add-DRAContact -Properties <Hashtable> -Domain <String> [-DRARestServer<String>] [-DRARestPort <Int32>] [-IgnoreCertificateErrors<SwitchParameter>] [-Force <SwitchParameter>] [-Timeout <Int32>] [<CommonParameters>]

Description

The Add-DRAContact cmdlet adds a contact object to a domain managed by DRA. The requesting user must have the Create Contact power. To see the complete list of available properties, perform a Get-Member command on the object returned from any DRAContact command.

Parameters

Attribute / Description

Parameters / Values

Required

Position

Default Value

Accept Pipeline input?

Accept wildcard characters?

Properties <Hashtable>

A hashtable of property values. The key is the name of a defined attribute in the REST interface. For example: -Properties @{Attribute1DRADisplayName="my value"; Attribute2DRADisplayName=value}

Multiple values are specified as a comma-separated list.For example: -Properties @{Attribute1DRADisplayName=value1, value2}

If the property name contains non-alphanumeric characters it needs to be quoted.For example: -Properties @{"Attribute1-DRA-DisplayName"=value}

If the property value contains a quote it needs to be escaped with a backtick (`).For example: -Properties @{Attribute1DRADisplayName="`"sample`" value"}

true

named

 

true (ByPropertyName)

false

Domain <String>

The domain of the object in fqdn format. For example: mydomain.corp

true

named

 

true (ByPropertyName)

false

DRARestServer [<String>]

The name of the computer running the DRA Rest Service. The requested DRA operation will execute on this server. If the parameter is not specified, the value defaults to 'localhost'.

false

named

 

true (ByPropertyName)

false

DRARestPort [<Int32>]

The port where the DRA REST Service listens for requests. If the parameter is not specified, the value defaults to 8755.

false

named

8755

true (ByPropertyName)

false

IgnoreCertificateErrors [<SwitchParameter>]

Allows the request to bypass any SSL certificate errors, such as the InvalidOperation error that occurs when the REST Service is bound to a self-signed certificate.

false

named

 

false

false

Force [<SwitchParameter>]

Suppresses any request for user input and supplies a 'yes' response. For example: -Force with a delete request will perform the delete without presenting the confirmation request to the user.

false

named

 

false

false

<CommonParameters>

Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see About CommonParameters.

 

 

 

 

 

NOTE:For more information, type "Get-Help Add-DRAContact -detailed". For technical information, type "Get-Help Add-DRAContact -full".

Example 8-1 1

PS C:\>Add-DRAContact  -Domain MyDomain.corp -Properties @{FriendlyName="MyDomain.corp/Accounting/Contact123"; Description="Contact for powershell";EmployeeId="xx123"}

This example creates a contact named Contact123 in Active Directory using the DRA FriendlyName property. The contact will be created in the domain MyDomain.corp in the Accounting OU. There are two properties set on this contact: Description and EmployeeId.

Example 8-2 2

PS C:\>Add-DRAContact  -Domain MyDomain.corp -Properties @{DistinguishedName="CN=Contact123,OU=Accounting, DC=MyDomain,DC=corp";Description="Contact for powershell";EmployeeId="xx123"}

This example creates a contact named Contact123 in Active Directory using the DRA DistinguishedName property. The contact will be created in the domain MyDomain.corp in the Accounting OU. There are two properties set on this contact: Description and EmployeeId.

Example 8-3 3

PS C:\>Add-DRAContact  -Domain MyDomain.corp -Properties @{FriendlyParentPath="MyDomain.corp/Accounting";Name="Contact123";Description="PS Desc 001";EmployeeId="ZZZ123";samAccountName="AltSameName123"}

This example creates the contact Contact123 in Active Directory using the Name and DRA FriendlyParentPath properties. The contact will be created in the domain MyDomain.corp in the Accounting OU. There are three properties set on this contact: Description, EmployeeId, and samAccountName.