Update Enterprise Geodatabase License (Data Management Tools)

Summary

Updates the ArcGIS Server license in an enterprise geodatabase.

If your organization licenses ArcGIS Server for a set time period, the geodatabase administrator can run the Update Enterprise Geodatabase License tool with a new ArcGIS Server authorization file to update license information in the geodatabase before the existing license expires. This allows clients to continue working with the geodatabase without interruptions caused by expired licenses.

Usage

The input workspace must be an enterprise geodatabase. This tool does not work with any other type of geodatabase.
You must connect to the enterprise geodatabase as the geodatabase administrator to run this tool.
To generate a license file for an enterprise geodatabases licensed with ArcGIS Enterprise on Kubernetes, use the exportGeodatabaseLicense REST operation.

Label Explanation Data type

Label	Explanation	Data type
Input Database Connection	A database connection (`.sde` file) to the enterprise geodatabase to authorize with a new ArcGIS Server enterprise authorization file. The database connection file must connect to the database as the geodatabase administrator.	Workspace
Authorization File	The path and file name of the keycodes file generated when ArcGIS Server enterprise was authorized. If necessary, copy the file from the ArcGIS Server machine to a directory that the tool can access. ArcGIS Server creates the keycodes file in the following location: `\\Program Files\ESRI\License<release#>\sysgen` (Microsoft Windows servers) or `/arcgis/server/framework/runtime/.wine/drive_c/Program Files/ESRI/License<release#>/sysgen` (Linux servers).	File

Input Database Connection

A database connection (.sde file) to the enterprise geodatabase to authorize with a new ArcGIS Server enterprise authorization file.

The database connection file must connect to the database as the geodatabase administrator.

Workspace

Authorization File

The path and file name of the keycodes file generated when ArcGIS Server enterprise was authorized. If necessary, copy the file from the ArcGIS Server machine to a directory that the tool can access.

ArcGIS Server creates the keycodes file in the following location: \\Program Files\ESRI\License<release#>\sysgen (Microsoft Windows servers) or /arcgis/server/framework/runtime/.wine/drive_c/Program Files/ESRI/License<release#>/sysgen (Linux servers).

File

Derived output

Label	Explanation	Data type
Output Workspace	The updated enterprise geodatabase.	Workspace

arcpy.management.UpdateEnterpriseGeodatabaseLicense(input_database, authorization_file)

Name Explanation Data type

Name	Explanation	Data type
input_database	A database connection (`.sde` file) to the enterprise geodatabase to authorize with a new ArcGIS Server enterprise authorization file. The database connection file must connect to the database as the geodatabase administrator.	Workspace
authorization_file	The path and file name of the keycodes file generated when ArcGIS Server enterprise was authorized. If necessary, copy the file from the ArcGIS Server machine to a directory that the tool can access. ArcGIS Server creates the keycodes file in the following location: `\\Program Files\ESRI\License<release#>\sysgen` (Microsoft Windows servers) or `/arcgis/server/framework/runtime/.wine/drive_c/Program Files/ESRI/License<release#>/sysgen` (Linux servers).	File

input_database

A database connection (.sde file) to the enterprise geodatabase to authorize with a new ArcGIS Server enterprise authorization file.

The database connection file must connect to the database as the geodatabase administrator.

Workspace

authorization_file

The path and file name of the keycodes file generated when ArcGIS Server enterprise was authorized. If necessary, copy the file from the ArcGIS Server machine to a directory that the tool can access.

File

Derived output

Name	Explanation	Data type
out_workspace	The updated enterprise geodatabase.	Workspace

Code sample

UpdateEnterpriseGeodatabaseLicense example 1 (Python window)

The following script can be run in a Python window to update license information in an enterprise geodatabase.

In this example, the database connection file is enterprisegdb.sde and is located in a folder named gdbs. The keycodes file was copied to the temp folder.

import arcpy
ent_gdb = "C:\\gdbs\\enterprisegdb.sde"
authorization_file = "C:\\temp\\keycodes"
arcpy.management.UpdateEnterpriseGeodatabaseLicense(ent_gdb, authorization_file)

UpdateEnterpriseGeodatabaseLicense example 2 (stand-alone script)

The following is a stand-alone Python script you can alter and use to update the license information in an enterprise geodatabase.

In this example, the database connection file is enterprisegdb.sde and is located in a directory named gdbs in the geodatabase administrators usr directory. The keycodes file was copied to a directory named scratch.

# Import arcpy module
import arcpy

# Local variables:
ent_gdb = "/usr/gdbs/enterprisegdb.sde"
authorization_file = "/usr/scratch/keycodes"

# Process: Import authorization information from a new keycodes file.
arcpy.management.UpdateEnterpriseGeodatabaseLicense(ent_gdb, authorization_file)

Environments

Current Workspace

Licensing information

Basic: No
Standard: Yes
Advanced: Yes

Update Enterprise Geodatabase License (Data Management Tools)

Summary

Usage

Parameters

Derived output

Environments

Licensing information

Related topics