This content has been machine translated dynamically.
Dieser Inhalt ist eine maschinelle Übersetzung, die dynamisch erstellt wurde. (Haftungsausschluss)
Cet article a été traduit automatiquement de manière dynamique. (Clause de non responsabilité)
Este artículo lo ha traducido una máquina de forma dinámica. (Aviso legal)
此内容已经过机器动态翻译。 放弃
このコンテンツは動的に機械翻訳されています。免責事項
이 콘텐츠는 동적으로 기계 번역되었습니다. 책임 부인
Este texto foi traduzido automaticamente. (Aviso legal)
Questo contenuto è stato tradotto dinamicamente con traduzione automatica.(Esclusione di responsabilità))
This article has been machine translated.
Dieser Artikel wurde maschinell übersetzt. (Haftungsausschluss)
Ce article a été traduit automatiquement. (Clause de non responsabilité)
Este artículo ha sido traducido automáticamente. (Aviso legal)
この記事は機械翻訳されています.免責事項
이 기사는 기계 번역되었습니다.책임 부인
Este artigo foi traduzido automaticamente.(Aviso legal)
这篇文章已经过机器翻译.放弃
Questo articolo è stato tradotto automaticamente.(Esclusione di responsabilità))
Translation failed!
Get-AcctDBSchema
Gets SQL scripts to create or maintain the database schema for the Citrix ADIdentity Service.
Syntax
Get-AcctDBSchema [-DatabaseName <String>] [-ServiceGroupName <String>] [-ScriptType <ScriptTypes>] [-LocalDatabase] [-Sid <String>] [-DatabaseRights <String>] [-AzureDatabase] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]
<!--NeedCopy-->
Detailed Description
Gets SQL scripts that can be used to create a new ADIdentity Service database schema, add a new ADIdentity Service to an existing site, remove an ADIdentity Service from a site, or create a database server logon for an ADIdentity Service.
If no Sid parameter is provided, the scripts obtained relate to the currently selected ADIdentity Service instance, otherwise the scripts relate to ADIdentity Service instance running on the machine identified by the Sid provided. When obtaining the Evict script (See ScriptType), a Sid parameter must be supplied.
The current service instance is that on the local machine, or that explicitly specified by the last usage of the -AdminAddress parameter to an ADIdentity SDK cmdlet.
The service instance used to obtain the scripts does not need to be a member of a site or have had its database connection configured.
The database scripts only support Microsoft SQL Server, or SQL Server Express, and require Windows integrated authentication to be used. They can be run using SQL Server’s SQLCMD utility, or by copying the script into an SQL Server Management Studio (SSMS) query window and executing the query. If using SSMS, the query must be executed in ‘SMDCMD mode’.
The ScriptType parameter determines which script is obtained. If ScriptType is not specified, or is FullDatabase or Database, the script contains:
-
Creation of service schema
-
Creation of database server logon
-
Creation of database user
-
Addition of database user to ADIdentity Service roles
If ScriptType is Instance, the returned script contains:
-
Creation of database server logon
-
Creation of database user
-
Addition of database user to ADIdentity Service roles
If ScriptType is Evict, the returned script contains:
-
Removal of ADIdentity Service instance from database
-
Removal of database user
If ScriptType is Login, the returned script contains:
- Creation of database server logon only
If the service uses two data stores they can exist in the same database. You do not need to configure a database before using this command.
Related Commands
Parameters
| Name | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|
| DatabaseName | Specifies the name of the database into which the new ADIdentity service schema is to be placed, or in which it already exists. The database itself is not created by any of the script types; it must already exist before the scripts are run. | false | false | |
| ServiceGroupName | The name of the service group to be used when creating the Citrix ADIdentity Service database schema. The service group is the collection of all ADIdentity Services that share the same database and are considered equal (i.e. any service in the same service group can be used interchangeably). | false | false | |
| ScriptType | Specifies the type of database script returned. Available script types are |
FullDatabase: Creates a database schema for the Citrix ADIdentity Service in a database instance that does not already contain one. This is used when creating a new site. DatabaseName and ServiceGroupName are required parameters for this script type. Database: Performs the same function as “FullDatabase”. Instance: Adds a ADIdentity Service instance to a database and so to the associated site. Appropriate database server logons and users are created to allow the service instance access to the required service schemas. Evict: Removes a ADIdentity Service instance from the database and so from the site. All reference to the service instance is removed from the database. DatabaseName and Sid are required parameters for this script type. Login: Adds a logon for the ADIdentity Service instance to a database server. This is specifically for use when configuring SQL Server mirroring where the mirror server must have appropriate logons created for all service instances in the site. | false | false | | | LocalDatabase | Specifies whether the database script is to be used in a database instance run on the same controller as other services in the service group. Including this parameter ensures the script creates only the required permissions for local services to access the database schema for ADIdentity services. If this parameter is specified inappropriately, the service instance will not be able to connect to the database. | false | false | | | Sid | Specifies the SID of the controller on which the ADIdentity Service instance to remove from the database is running (only valid for a script type of Evict). | false | true (ByValue) | None | | DatabaseRights | Specifies the rights to run the database script under. Available rights are: Mixed: Creates a database schema which uses all rights. SysAdmin: Creates a database schema which does the minimum with the SysAdmin (sa) rights. DbOwner: Creates a database schema which only needs Database Owner (dbo) rights. This script expects to be used after the SysAdmin script has been run. | false | false | Mixed | | AzureDatabase | Specifies that the generated schema must be compatible with Azure SQL limits, including not generating code for logins. | false | false | | | BearerToken | Specifies the bearer token assigned to the calling user | false | false | | | TraceParent | Specifies the trace parent assigned for internal diagnostic tracing use | false | false | | | TraceState | Specifies the trace state assigned for internal diagnostic tracing use | false | false | | | VirtualSiteId | Specifies the virtual site the PowerShell snap-in will connect to. | false | false | | | AdminAddress | The address of a Citrix Virtual Apps and Desktops controller the PowerShell snap-in will connect to. You can provide this as a host name or an IP address. | false | false | Localhost. Once a value is provided by any cmdlet, this value becomes the default. |
Input Type
None
You cannot pipe input into this cmdlet.
Return Values
System.String
A string containing the required SQL script for application to a database.
Notes
If the command fails, the following errors can be returned.
-
GetSchemasFailed: The database schema could not be found.
-
ActiveDirectoryAccountResolutionFailed: The specified Active Directory account or Group could not be found.
-
DatabaseError: An error occurred in the service while attempting a database operation.
-
DatabaseNotConfigured: The operation could not be completed because the database for the service is not configured.
-
DataStoreException: An error occurred in the service while attempting a database operation - communication with the database failed for various reasons.
-
PermissionDenied: You do not have permission to execute this command.
-
AuthorizationError: There was a problem communicating with the Citrix Delegated Administration Service.
-
CommunicationError: There was a problem communicating with the remote service.
-
ExceptionThrown: An unexpected error occurred. For more details, see the Windows event logs on the controller or the Citrix Virtual Apps and Desktops logs.
Examples
Example 1
C:\PS>Get-AcctDBSchema -DatabaseName MySiteDB -ServiceGroupName MyServiceGroup > C:\ADIdentitySchema.sql
<!--NeedCopy-->
Description
Gets a script to create the full database schema for the Citrix ADIdentity Service and copies it to a file called “C:\ADIdentitySchema.sql” This script can be used to create the service schema in a database with name “MySiteDB”, which must already exist, and must not already contain a ADIdentity service schema.
Example 2
C:\PS>Get-AcctDBSchema -DatabaseName MySiteDB -ScriptType Login > C:\ADIdentityLogins.sql
<!--NeedCopy-->
Description
Gets a script to create the appropriate database server logon for the ADIdentity service. This can be used when configuring a mirror server for use.
Share
Share
In this article
This Preview product documentation is Citrix Confidential.
You agree to hold this documentation confidential pursuant to the terms of your Citrix Beta/Tech Preview Agreement.
The development, release and timing of any features or functionality described in the Preview documentation remains at our sole discretion and are subject to change without notice or consultation.
The documentation is for informational purposes only and is not a commitment, promise or legal obligation to deliver any material, code or functionality and should not be relied upon in making Citrix product purchase decisions.
If you do not agree, select I DO NOT AGREE to exit.