New-R1DataSource

New-R1DataSource

SYNOPSIS

Creates a data source.

SYNTAX

Ldap (Default)

New-R1DataSource -name <String> -type <String> [-active <Boolean>] [-description <String>]
 [-defaultSchema <String>] [-addedSchemas <String[]>] [-groupId <String>] -hostName <String> -port <Int32>
 -bindDn <String> [-ssl <Boolean>] [-baseDn <String>] [-pagedResultsControl <Boolean>] [-pageSize <Int32>]
 [-chaseReferrals <Boolean>] [-failovers <Object[]>] [-verifySslHostname <Boolean>] [-kerberosProfile <String>]
 [-sdcMappings <Hashtable>] [-password <SecureString>] [-WhatIf] [-Confirm] [<CommonParameters>]

Database

New-R1DataSource -name <String> -type <String> [-active <Boolean>] [-description <String>]
 [-defaultSchema <String>] [-addedSchemas <String[]>] [-groupId <String>] [-sdcMappings <Hashtable>]
 -driverClassName <String> -url <String> -username <String> [-failOverName <String>] [-onPremHost <String>]
 [-onPremPort <Int32>] [-password <SecureString>] [-WhatIf] [-Confirm] [<CommonParameters>]

Custom

New-R1DataSource -name <String> -type <String> [-active <Boolean>] [-description <String>]
 [-defaultSchema <String>] [-addedSchemas <String[]>] [-groupId <String>] -customProps <Hashtable>
 [-onPremHost <String>] [-onPremPort <Int32>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Creates a data source of one of three kinds. Which kind is created is decided by the parameters supplied: an LDAP source needs a host, port and bind DN; a database source needs a driver class, URL and username; a custom source needs its custom properties.

The request body is sent as UTF8 bytes so that a supplied password cannot be captured by Windows PowerShell parameter binding or module logging.

EXAMPLES

Example 1

$Secret = Read-Host -Prompt 'Bind password' -AsSecureString
New-R1DataSource -name 'opendj' -type 'Generic LDAP' -hostName 'ldap.example.com' -port 389 -bindDn 'cn=DirectoryManager' -baseDn 'o=example' -password $Secret

Creates an LDAP data source.

Example 2

New-R1DataSource -name 'advworks' -type 'Generic DB' -driverClassName 'org.postgresql.Driver' -url 'jdbc:postgresql://db/adv' -username 'appUser' -password $Secret

Creates a database data source.

Example 3

New-R1DataSource -name 'mycustom' -type 'Custom' -customProps @{ url = 'https://example.test' }

Creates a custom data source from a set of properties.

PARAMETERS

-name

The name of the data source.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-type

The data source type, as listed by Get-R1DataSourceType.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-active

Whether the data source is active.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-description

A description of the data source.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-defaultSchema

The schema used by default for this data source.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-addedSchemas

The schemas linked to the data source.

Type: String[]
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-groupId

The group the data source belongs to.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-hostName

——————————————————————————— ldap

Type: String
Parameter Sets: Ldap
Aliases: host

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-port

The port of the directory server.

Type: Int32
Parameter Sets: Ldap
Aliases:

Required: True
Position: Named
Default value: 0
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-bindDn

The DN used to bind to the directory server.

Type: String
Parameter Sets: Ldap
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-ssl

Whether the connection uses SSL.

Type: Boolean
Parameter Sets: Ldap
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-baseDn

The base DN of the data read from the directory server.

Type: String
Parameter Sets: Ldap
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-pagedResultsControl

Whether the paged results control is used when searching.

Type: Boolean
Parameter Sets: Ldap
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-pageSize

The number of entries requested per page.

Type: Int32
Parameter Sets: Ldap
Aliases:

Required: False
Position: Named
Default value: 0
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-chaseReferrals

Whether referrals returned by the server are followed.

Type: Boolean
Parameter Sets: Ldap
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-failovers

The failover servers, each with a host, port and ssl setting.

Type: Object[]
Parameter Sets: Ldap
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-verifySslHostname

Whether the host name on the server certificate is verified.

Type: Boolean
Parameter Sets: Ldap
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-kerberosProfile

The Kerberos profile used to authenticate.

Type: String
Parameter Sets: Ldap
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-driverClassName

—————————————————————————– database

Type: String
Parameter Sets: Database
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-url

The JDBC URL of the database.

Type: String
Parameter Sets: Database
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-username

The account used to connect to the database.

Type: String
Parameter Sets: Database
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-failOverName

The name of the failover data source.

Type: String
Parameter Sets: Database
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-customProps

——————————————————————————- custom

Type: Hashtable
Parameter Sets: Custom
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-onPremHost

—————————————————————— database and custom

Type: String
Parameter Sets: Database, Custom
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-onPremPort

The port of the on premises connector.

Type: Int32
Parameter Sets: Database, Custom
Aliases:

Required: False
Position: Named
Default value: 0
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-password

——————————————————————– ldap and database

Type: SecureString
Parameter Sets: Ldap, Database
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-sdcMappings

A map of Secure Data Connector mappings, keyed by name. Each value gives the host and port the connector reaches the data source on, and optionally the group id.

Type: Hashtable
Parameter Sets: Ldap, Database
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

None

OUTPUTS

System.Void

NOTES

RELATED LINKS

Get-R1DataSource

Set-R1DataSource

Test-R1DataSourceConnection