Skip to main content

CreateServerInput

The mandatory input field needed to create an Avantra server object.

input CreateServerInput {
name: String!
description: String
monitoring: Boolean!
dnsDomain: String
dnsDomainId: ID
dnsAliases: [String!]
ipAddress: String!
customerId: ID!
applicationType: String
applicationTypeId: ID
roleId: ID
timezone: String
notes: String
customAttributes: [CustomAttributeInput!]
administratorUserId: ID
deputyUserId: ID
serviceLevelAgreementId: ID
cloudServiceAuthenticationId: ID
serialNumber: String
gateway: Boolean!
natTraversal: Boolean!
operationalSince: DateTime
operationalUntil: DateTime
virtualServerConfiguration: VirtualServerInput
}

Fields

CreateServerInput.name ● String! non-null scalar

The name of the server.

CreateServerInput.description ● String scalar

The description for this server.

CreateServerInput.monitoring ● Boolean! non-null scalar

Should the monitoring be turned on or off after the creation of the server.

CreateServerInput.dnsDomain ● String scalar

A dns domain known to Avantra: It has to be registered in Avantra's customizations. If unknown the domain will be ignored.

CreateServerInput.dnsDomainId ● ID scalar

If you only have the DNS domain's ID you can use it as well. If it is set the dnsDomain field will be ignored.

CreateServerInput.dnsAliases ● [String!] list scalar

DNS aliases

CreateServerInput.ipAddress ● String! non-null scalar

IP address or FQDN

CreateServerInput.customerId ● ID! non-null scalar

Customer ID - for which avantra customer this server should be added. To fetch the list of available IDs use e.g. the customers(...) query.

CreateServerInput.applicationType ● String scalar

Application Type: Has to be one of Avantra's application types defined in the customizations.s

CreateServerInput.applicationTypeId ● ID scalar

Application Type ID: if this is set the application type field is ignored.

CreateServerInput.roleId ● ID scalar

The role of this monitored system.

CreateServerInput.timezone ● String scalar

What is the server's timezone. If not set it will fall back to default.

CreateServerInput.notes ● String scalar

The notes for this server.

CreateServerInput.customAttributes ● [CustomAttributeInput!] list input

Custom attributes (see documentation) to set.

CreateServerInput.administratorUserId ● ID scalar

The administrator user ID for the monitored system.

CreateServerInput.deputyUserId ● ID scalar

The administrator deputy user ID for the monitored system.

CreateServerInput.serviceLevelAgreementId ● ID scalar

The service level agreement ID.

CreateServerInput.cloudServiceAuthenticationId ● ID scalar

If this is a cloud server this field can hold the authentication's ID (see cloudServiceAuthentications() query).

CreateServerInput.serialNumber ● String scalar

The serial number for this server.

CreateServerInput.gateway ● Boolean! non-null scalar

Is this server a gateway

CreateServerInput.natTraversal ● Boolean! non-null scalar

Does this server implement NAT traversal.

CreateServerInput.operationalSince ● DateTime scalar

Operational since

CreateServerInput.operationalUntil ● DateTime scalar

Operational until

CreateServerInput.virtualServerConfiguration ● VirtualServerInput input

Input type to indicate whether this is a virtual server or not (default is false => null). NOTE: if this is set then it forces the physicalServerIds of the VirtualServerInput field to contain some valid physical server ids.

Member Of

createServer mutation ● createServerDraft mutation