CreateGISServerConnectionFile (arcpy.mapping)

Summary

This function creates a connection file that can be used to connect to a GIS Server.

Discussion

This function creates a connection file that can be used to connect to ArcGIS for Server or Spatial Data Server. The connection file can then be used to publish GIS services. For example, CreateGISServerConnectionFile can be used in conjunction with CreateMapSDDraft, Stage Service, and Upload Service Definition to completely automate the map publishing process.

Related functions:

CreateMapSDDraftCreateGPSDDraftCreateImageSDDraftCreateGeocodeSDDraft

Syntax

CreateGISServerConnectionFile (connection_type, out_folder_path, out_name, server_url, server_type, {use_arcgis_desktop_staging_folder}, {staging_folder_path}, {username}, {password}, {save_username_password})

Parameter	Explanation	Data Type
connection_type	A string that represents the connection type. You can create a connection to use, publish, or administer GIS Services. USE_GIS_SERVICES —Use GIS Services. PUBLISH_GIS_SERVICES —Publish GIS Services. ADMINISTER_GIS_SERVICES —Administer GIS Services.	String
out_folder_path	The folder path where the .ags file will be stored. Entering a value of GIS Servers will put the .ags file in the GIS Servers node in the Catalog window.	String
out_name	The name of the .ags file. The output file extension must end with .ags.	String
server_url	A string that represents the URL to the server.	String
server_type	A string that represents the type of server. ARCGIS_SERVER —ArcGIS for Server server type SPATIAL_DATA_SERVER —Spatial Data Server server type Legacy: If you are using SPATIAL_DATA_SERVER server_type, starting at ArcGIS 10.2.1 for Desktop, only USE_GIS_SERVICES connection_type is supported. For more information, see What's new in ArcGIS 10.2.1 for Server. Any connection_type is supported for ARCGIS_SERVER server_type. (The default value is ARCGIS_SERVER)	String
use_arcgis_desktop_staging_folder	A Boolean that determines whether to use ArcGIS for Desktop's staging folder. If set to true, you do not have to enter a staging_folder_path as ArcGIS for Desktop's staging folder will be used. This parameter is only used if the connection_type is PUBLISH_GIS_SERVICES or ADMINISTER_GIS_SERVICES. (The default value is True)	Boolean
staging_folder_path	A string that represents the staging folder path. If you will be using this connection to create and save service definitions, you can choose where the service definition files will be staged on disk. By default, they are staged in a folder on your local machine. If this parameter is set to None, ArcGIS for Desktop's staging folder will be used. This parameter is only used if the connection_type is PUBLISH_GIS_SERVICES or ADMINISTER_GIS_SERVICES.	String
username	A string that represents the user name to the GIS server.	String
password	A string that represents the password to the GIS server.	String
save_username_password	A Boolean that represents whether the user name and password to the GIS Server will be saved in the connection file. SAVE_USERNAME — Save the user name and password in the connection file. DO_NOT_SAVE_USERNAME — Do not save the user name and password in the connection file. (The default value is True)	Boolean

Code Sample

CreateGISServerConnectionFile example 1

The following script creates an ArcGIS for Server administration connection file in a user-defined folder.

import arcpy
outdir = 'C:/Project'
out_folder_path = outdir
out_name = 'test.ags'
server_url = 'http://MyServer:6080/arcgis/admin'
use_arcgis_desktop_staging_folder = False
staging_folder_path = outdir
username = 'admin'
password = 'admin'
    
arcpy.mapping.CreateGISServerConnectionFile("ADMINISTER_GIS_SERVICES",
                                            out_folder_path,
                                            out_name,
                                            server_url,
                                            "ARCGIS_SERVER",
                                            use_arcgis_desktop_staging_folder,
                                            staging_folder_path,
                                            username,
                                            password,
                                            "SAVE_USERNAME")

CreateGISServerConnectionFile example 2

The following script creates an ArcGIS for Server user connection file in the GIS Servers node in the Catalog window.

import arcpy
out_folder_path = 'GIS Servers'
out_name = 'test.ags'
server_url = 'http://MyServer:6080/arcgis/services'
   
arcpy.mapping.CreateGISServerConnectionFile("USE_GIS_SERVICES",
                                            out_folder_path,
                                            out_name,
                                            server_url,
                                            "ARCGIS_SERVER",
                                            username='admin',
                                            password='admin',
                                            save_username_password=True)