Era.Common.DataDefinition.Task.Server.RemoteInstall

Description

Executes remote deployment of ERA agent.

Properties

Name	JsonSchemaType	Description
agentPeerCertificatePassword	string	Password for agentPeerCertificateUuid or customAgentPeerCertificate.
agentPeerCertificateUuid	reference to Era.Common.DataDefinition.Common.Uuid	Internal peer certificate UUID.
computerUuids	array of references to Era.Common.DataDefinition.Common.Uuid	Target computer UUIDs.
customAgentPeerCertificate	string	Custom agent PFX certificate instead of internal certificate.
enableTelemetryCrashDumps	boolean	Enables telemetry and crash dumps sending in case it is supported.
groupUuids	array of references to Era.Common.DataDefinition.Common.Uuid	Target whole static groups.
packages	array of references to Era.Common.DataDefinition.Task.Server.RemoteInstall_RepositoryPackage	Agent packages.
serverHostname	string	Server hostname to which will be deployed agents connecting to.
sshPort	integer	SSH port for Linux/Mac deployment.
useAgentPeerCertificatePassword	boolean	If set to true, value of agentPeerCertificatePassword is used. Otherwise the password is not used.
userCredentials	reference to Era.Common.DataDefinition.Common.UserCredentials	Administrator credentials for target computers.

Dual message (request/response)

No dual message.

Referenced in messages

Era.Common.DataDefinition.Task.ServerTaskConfiguration

JsonSchema

{
    "title": "Era.Common.DataDefinition.Task.Server.RemoteInstall",
    "type": "object",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "additionalProperties": false,
    "required": [
        "Era.Common.DataDefinition.Task.Server.RemoteInstall"
    ],
    "properties": {
        "Era.Common.DataDefinition.Task.Server.RemoteInstall": {
            "$ref": "#/definitions/RemoteInstall"
        }
    },
    "definitions": {
        "RemoteInstall": {
            "oneOf": [
                {
                    "required": [
                        "agentPeerCertificateUuid"
                    ]
                },
                {
                    "required": [
                        "customAgentPeerCertificate"
                    ]
                }
            ],
            "additionalProperties": false,
            "required": [
                "useAgentPeerCertificatePassword",
                "userCredentials"
            ],
            "type": "object",
            "properties": {
                "agentPeerCertificatePassword": {
                    "type": "string"
                },
                "agentPeerCertificateUuid": {
                    "$ref": "Era.Common.DataDefinition.Common.Uuid#/definitions/Uuid"
                },
                "computerUuids": {
                    "type": "array",
                    "items": [
                        {
                            "$ref": "Era.Common.DataDefinition.Common.Uuid#/definitions/Uuid"
                        }
                    ]
                },
                "customAgentPeerCertificate": {
                    "type": "string"
                },
                "enableTelemetryCrashDumps": {
                    "type": "boolean"
                },
                "groupUuids": {
                    "type": "array",
                    "items": [
                        {
                            "$ref": "Era.Common.DataDefinition.Common.Uuid#/definitions/Uuid"
                        }
                    ]
                },
                "packages": {
                    "type": "array",
                    "items": [
                        {
                            "$ref": "Era.Common.DataDefinition.Task.Server.RemoteInstall_RepositoryPackage#/definitions/RemoteInstall_RepositoryPackage"
                        }
                    ]
                },
                "serverHostname": {
                    "pattern": "\\s*.{1,}\\s*",
                    "type": "string"
                },
                "sshPort": {
                    "exclusiveMaximum": false,
                    "exclusiveMinimum": false,
                    "maximum": 65535,
                    "minimum": 0,
                    "type": "integer"
                },
                "useAgentPeerCertificatePassword": {
                    "type": "boolean"
                },
                "userCredentials": {
                    "$ref": "Era.Common.DataDefinition.Common.UserCredentials#/definitions/UserCredentials"
                }
            }
        }
    }
}