The properties available to ArcGIS Video Server administrators are described below. Each property is described along with its path, located in the ArcGIS Video Server administration site by browsing to the URL https://machine.domain.com:21443/arcgis/admin.
Designate the ArcGIS Video Server account
The default ArcGIS Video Server account name is arcgis. Accepting this default is sufficient for most nonproduction deployments; however, for production systems, it is recommended that you create a domain or Active Directory account before installing ArcGIS Video Server.
You can specify a local account or a domain account. You can export the setup configuration file when you install ArcGIS Video Server on the first machine in your site and use the configuration file when you install ArcGIS Video Server on the other machines in your site. This ensures that the ArcGIS Video Server account is configured the same on all the machines in your site.
Domain account
A domain account allows access to data on remote systems. A domain account is preferable for security purposes because the account is centrally managed.
When specifying a domain account, use the format DOMAIN\username. If you do not specify the domain, the ArcGIS Video Server installation wizard creates a local account with the username you specified. If you specify a domain account that does not exist, the installation returns an error.
If your login settings deny login rights to the machine where ArcGIS Video Server is installed, an error will occur during installation. You do not need to use the Log on locally group policy settings for the ArcGIS Video Server account.
Local account
If you specify a local account, the local account and password must exist on each machine in the ArcGIS Video Server site and must be identical. You can create the local account with the same password on each machine before installing ArcGIS Video Server, or you can use the ArcGIS Video Server installation wizard to create the local account. You must use the same username and password on every machine in the site.
If you created a local account as part of the installation, the password you specify for the account must adhere to your operating system's local security policy. If the password does not meet the minimum strength requirements of the operating system, an error will occur. Consult the Microsoft documentation for the version of Windows you are using to learn how to access and review the security policy on your machines.
Group managed service account
A group managed service account (gMSA) is an Active Directory domain account that provides automatic password management. The account cannot be used for interactive logins and is restricted for use on only a predefined group of servers.
Using a gMSA is especially advantageous when a service account governs software on multiple machines, such as in a multiple-machine ArcGIS Video Server site. Because the gMSA works at the domain level, it can regularly change the service account password on each machine with no manual steps required.
You can use the configureserviceaccount command line tool, which is described below, to configure the ArcGIS Video Server service to run under a gMSA. This tool is in the <Video_Install>\tools\ConfigUtility directory. For the username parameter, the group managed service account can be specified with or without the $ symbol at the end. The password parameter is not needed. The readconfig and writeconfig parameters both function the same with a group managed service account.
The following is a sample command to configure a gMSA as the ArcGIS Video Server account:
configureserviceaccount.bat --username mydomain\enterprise-gmsa$ --writeconfig c:\temp\domainaccountconfig.xmlImport a root certificate
To import a root certificate, click Home > Machines > MachineName > sslCertificates > importRootOrIntermediate.
This operation imports a CA root and intermediate certificates into the keystore. To create a production-quality CA-signed certificate, add the CA certificates to the keystore that enables the SSL mechanism to trust the CA (and the certificates it has signed). While most of the popular CA certificates are available in the keystore, you can use this operation if you have a custom CA or specific intermediate certificates.
Update the security configuration
To update the security configuration, click Home > Security > Config > Update.
This operation updates the security configuration, including TLS protocols and cipher suites, for the ArcGIS Video Server site. This operation causes the REST service endpoints to be redeployed on every server machine in the site. If you updated the communication protocol as part of this operation, it takes ArcGIS Web Adaptor one minute to recognize changes to the communication protocol of the site.
Edit system properties
Administrators can edit ArcGIS Video Server properties to fit their organization. Custom property values can be set at https://machine.domain.com:21443/arcgis/admin/system/properties/update. When setting a custom system property, the property must be set as a valid JSON object. Multiple system properties can be set at a time, as long as they are strung together as valid JSON. The following is an example:
{
"maxFrameCount": 1000,
"maxFileUploadSize": 5000
}
Define the maximum frame count
The maximum frame count determines the maximum number of frames that can be returned on the frame set creation operation. The minimum allowed maximum frame count is 100.
The default is 1000 frames, for example, {"maxFrameCount": 1000}.
Define the maximum file upload size
The maximum file upload size sets the maximum threshold for a single file size that can be uploaded to the video server when publishing video files. If a file that exceeds this maximum size is uploaded during publishing, the process will fail. The highest this property can be set to is 10 GB (10000). If this property is set to 0 GB, the publishing of video files will be disabled.
The default is 5 GB, for example, {"maxFileUploadSize":"5000"}.
Define the elevation source
An administrator can define the elevation data source used to orthorectify the computed polygon of each image footprint. An elevation imagery service item ID can be set as the source. If no elevation source is defined, a constant elevation = 0 is used. Using an elevation source increases the accuracy of the image footprints.
The default is set to use a constant elevation = 0 but can be set with an existing elevation imagery service item ID, for example, {"elevationSource":"a08984c643a24bfd8f8d2eb0d192357d"}.
Configure ArcGIS Web Adaptor
To configure ArcGIS Web Adaptor, click Home > System > Web Adaptors > WebAdaptorConfig.
The ArcGIS Web Adaptor configuration is a resource for all the configuration parameters shared across the web adaptors in the site. This resource identifies the shared key used by all the web adaptors to encrypt key data bits in the incoming requests to the server.
Edit the log settings
To edit the log settings, click Home > Logs > Settings > Edit.
This procedure updates the log settings for the entire server site, such as log output location, level, and format, as well as log file age.
Set the default item data store
To edit the default item data store, click Home > Data > Items > Set Default Item.
The default item data store is the location where original video files and their corresponding metadata files, and output encoded video files and their corresponding metadata files will be stored after a successful publish operation. By default, this is set to FILESYSTEM.
Register the data store
To register an existing data store, click Home > Data > Configure Enterprise Data Stores > Submit.
By default, ArcGIS Video Server stores all video and metadata files on the file system. An organization can register an existing object data store to use as the output location of video and metadata. This procedure searches for an existing object data store and registers it to the video server. This data store can then be set as the default data store using the Set default item data store workflow.
Delete a site
To delete a site, click Home > Delete Site.
This operation deletes the site configuration and releases all server resources. It is suited for development or test servers that need to be cleaned up regularly and can also be performed before uninstallation. Use caution with this option because it deletes all settings and other configurations and is an unrecoverable operation.
This operation performs the following tasks:
- All server machines participating in the site are stopped.
- All server machines are unregistered from the site.
- The configuration store is deleted.
Back up the site
It is recommended that you frequently export your site settings through the admin API. You can do this by browsing to Home > Export Site. When defining the destination property for the exported site, provide a network drive or a location other than the ArcGIS Video Server machine as the location. The destination location must be accessible to the ArcGIS Video Server machine. In the event of a site failure, the site can be recovered by creating a new server site and browsing to Home > Import Site.
Import site
Caution:
This administrative operation is not available when accessed through a web adaptor. This operation should be accessed using a direct URL to one of the GIS servers on the site.
This operation imports a site configuration into the currently running site. Importing a site means replacing all site configurations (including GIS services, security configurations, and so on) of the currently running site with those contained in the site configuration file you supply as input. The input site configuration file can be obtained through the exportSite operation.
This operation will restore all information included in the backup, as noted in exportSite. When it is complete, this operation returns a report as the response. You should review this report and fix any problems it lists to ensure your site is fully functioning again.
The importSite operation allows you to restore your site from a backup that you created using the exportSite operation. Note that the importSite operation uses the server directory paths from the exported configuration. Therefore, these paths must be available for the importSite operation to complete successfully.
Caution:
This operation is computationally expensive and can run for a long duration. Manual intervention may be required at the end of this operation to address any highlighted problems. Since this operation changes the site configuration completely, it is highly recommended that you do not access GIS services and administer the site while this operation is running.
Request parameters
| Parameter | Details |
|---|---|
| location | A file path to an exported configuration or an ID referencing the stored configuration on the server. Example |
| validate | Introduced at ArcGIS Enterprise 11.1. This parameter validates the file path specified in the location parameter, ensuring that it is accessible before performing the importSite operation. If set to true, the path will be validated, and the operation will return either a success response or an error message. The default value is false. Values: true | false |
| f | The response format. The default response format is html. Values: html | json | pjson |
Example usage
Below is a sample POST request for importSite:
POST /arcgis/admin/importSite HTTP/1.1
Host: machine.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []
location=\\server\share\backup\Jan-15-2023_11-50-33.agssite&validate=true&f=pjsonExport site
Exports the site configuration to a location you specify as input to this operation. The exported file includes and excludes the following information:
Caution:
You cannot make other administrative site configuration changes while a backup is in progress. Before performing the exportSite operation, ensure that all desired site configurations have been made.
Protecting information not included in the backup
As noted above, some information is not included in the backup of your site. It's recommended you manually back up this information at the same time you run the backup utility. When you restore the site, manually copy or move this information back to the site, for example:
- Service data—If the data used by your services was not copied to a folder on the server when publishing, it will not be included in the backup. Manually back up your data directories, geodatabases, databases, source tables, and any other information used by your services. When you restore the site, verify ArcGIS Video Server has permissions to access your data locations. For more information, see Making your data accessible to ArcGIS Video Server.
- Log messages—When the site is running, logs are created and distributed among all ArcGIS Video Server machines participating in your site. When you restore the site, move or copy the information back to the original logs directory.
- Primary site administrator name and password—After you restore a site, you continue using the primary site administrator name and password that was in place when performing the restore. This is true even if you restore a site whose primary site administrator had been disabled. It's recommended that you record the username and password and store it in a secure location before performing the restore.
- Statistics data—When the site is running, various service statistics are recorded. When you restore the site, move or copy the information back to the original statistics directory.
- ArcGIS Web Adaptor configurations—If your site includes one or more ArcGIS Web Adaptor, you'll need to reconfigure them with your site after performing the restore. For full instructions, see the configuration topics for IIS , Java (Windows), and Java (Linux).
Request parameters
| Parameter | Details |
|---|---|
| location (Optional) | A folder path, accessible to ArcGIS Video Server, where the exported site configuration will be written. If the location parameter is not specified, the server writes the exported site configuration file to a directory owned by the server and returns a virtual path (HTTPS URL) to the directory. The exported site configuration can be downloaded from the directory by accessing the returned URL. Example |
| validate | Introduced at ArcGIS Enterprise 11.1. This parameter validates the file path specified in the location parameter, ensuring that it is accessible before performing the importSite operation. If set to true, the path will be validated, and the operation will return either a success response or an error message. The default value is false. Values: true | false |
| f | The response format. The default response format is html. Values: html | json | pjson |
Example usage
Below is a sample POST request for exportSite with the location parameter defined:
POST /webadaptor/admin/exportSite HTTP/1.1
Host: machine.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []
location=\\server\share\backup&f=jsonThe following is a sample POST request for the exportSite operation that demonstrates leaving the location parameter undefined:
POST /webadaptor/admin/exportSite HTTP/1.1
Host: machine.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []
location=&validate=false&f=pjsonJSON Response example
Below is a response example for a request that specified the location parameter.
{
status: "success",
location: "\\videoserver\share\backup\Jan-15-2013_11-50-33.agssite"
}Below is a response example for a request that did not specify the location parameter.
{
status: "success",
location: "https://machine.domain.com/webadaptor/admin/uploads/i33d579b6-d8a8-4886-a1bc-671ae52e7a00"
}Examples with validation
The sample response below is for a request that defined the location parameter and set validate to true. This example demonstrates a success response, meaning that the path was accessible to ArcGIS Server:
{
status: "success",
}The sample response below is for a request that defined the location parameter and set validate to true. This example demonstrates a failure, meaning that the path was not accessible to ArcGIS Server:
{
"status": "error",
"messages": ["Unable to write to \\videoserver\share\backup. Verify the location is accessible and the service account running ArcGIS Video Server can write to it."],
"code": 500
}
ArcGIS Video Server import and export from local file system
No immediately noted differences. Read and write permissions are required for the service account in the output/input folder. In Linux, the service account equivalent is the user who installed ArcGIS Video Server. You should have full read, write. and run permissions on any relevant directories, including the Import/Export directory.
ArcGIS Video Server import and export from object or data store
It is recommended to have a domain account run the Video Server Windows Service if a shared network directory or object store is used. Full read and write permissions are required for the service account in the chosen location. In Linux, the service account equivalent is the user who installed ArcGIS Video Server.