schema
stringclasses
471 values
key
stringlengths
0
203
description
stringlengths
0
4.37k
object
stringlengths
2
322k
BizTalkServerApplicationSchema.json
Name
Name of the File
{"type": "string"}
BizTalkServerApplicationSchema.json
Path
Relative output filepath for the Files. Example: File\\File.txt
{"type": "string", "pattern": "\\w+[\\\\](\\w+\\.)*\\w+\\.\\w+"}
BizTalkServerApplicationSchema.json
DeploymentSequence
Sequence of Binding Files, Reference Assemblies, Pre-Processing and Post-Processing Scripts used in Deployment.
{"type": "array", "items": {"type": "string"}}
firebase-config.json
concurrency
Number of requests a function can serve at once.
{"type": "number"}
firebase-config.json
cors
If true, allows CORS on requests to this function. If this is a `string` or `RegExp`, allows requests from domains that match the provided value. If this is an `Array`, allows requests from domains matching at least one entry of the array. Defaults to true for {@link https.CallableFunction} and false otherwise.
{"type": ["string", "boolean"]}
firebase-config.json
cpu
Fractional number of CPUs to allocate to a function.
{"anyOf": [{"enum": ["gcf_gen1"], "type": "string"}, {"type": "number"}]}
firebase-config.json
enforceAppCheck
Determines whether Firebase AppCheck is enforced. Defaults to false.
{"type": "boolean"}
firebase-config.json
ingressSettings
Ingress settings which control where this function can be called from.
{"enum": ["ALLOW_ALL", "ALLOW_INTERNAL_AND_GCLB", "ALLOW_INTERNAL_ONLY"], "type": "string"}
firebase-config.json
invoker
Invoker to set access control on https functions.
{"enum": ["public"], "type": "string"}
firebase-config.json
labels
User labels to set on the function.
{}
firebase-config.json
maxInstances
Max number of instances to be running in parallel.
{"type": "number"}
firebase-config.json
memory
Amount of memory to allocate to a function.
{"enum": ["128MiB", "16GiB", "1GiB", "256MiB", "2GiB", "32GiB", "4GiB", "512MiB", "8GiB"], "type": "string"}
firebase-config.json
minInstances
Min number of actual instances to be running at a given time.
{"type": "number"}
firebase-config.json
omit
If true, do not deploy or emulate this function.
{"type": "boolean"}
firebase-config.json
preserveExternalChanges
Controls whether function configuration modified outside of function source is preserved. Defaults to false.
{"type": "boolean"}
firebase-config.json
region
HTTP functions can override global options and can specify multiple regions to deploy to.
{"type": "string"}
firebase-config.json
serviceAccount
Specific service account for the function to run as.
{"type": "string"}
firebase-config.json
timeoutSeconds
Timeout for the function in seconds, possible values are 0 to 540. HTTPS functions can specify a higher timeout.
{"type": "number"}
firebase-config.json
vpcConnector
Connect cloud function to specified VPC connector.
{"type": "string"}
firebase-config.json
vpcConnectorEgressSettings
Egress settings for VPC connector.
{"enum": ["ALL_TRAFFIC", "PRIVATE_RANGES_ONLY"], "type": "string"}
hws-config.json
namespace
Forces a specific namespace for connectors that perform namespace auto-detection (Advanced).
{"type": "string"}
hws-config.json
collectPeriod
Sets the collect period that Hardware Sentry uses to collects metrics from the monitored hosts (Default: 2m).
{"default": "2m"}
hws-config.json
disableAlerts
Disables Hardware Sentry's alerts for all the monitored hosts (Default: false).
{"type": "boolean", "default": false}
hws-config.json
discoveryCycle
Sets the cycle that Hardware Sentry uses to perform discoveries and detect new components in your monitored environment. By default, Hardware Sentry runs a discovery after 30 collects.
{"type": "integer", "default": "30"}
hws-config.json
exporter
Sets Hardware Sentry's internal Exporter configuration.
{"type": "object", "properties": {"otlp": {"type": ["object", "null"], "properties": {"headers": {"type": "object"}, "trustedCertificatesFile": {"type": "string", "default": "security/otel.crt"}, "endpoint": {"type": "string", "default": "https://localhost:4317"}}}}}
hws-config.json
otlp
Overrides Hardware Sentry's internal OTLP Exporter configuration.
{"type": ["object", "null"], "properties": {"headers": {"type": "object"}, "trustedCertificatesFile": {"type": "string", "default": "security/otel.crt"}, "endpoint": {"type": "string", "default": "https://localhost:4317"}}}
hws-config.json
headers
Sets Hardware Sentry's OTLP Exporter headers, such as the `Authorization` header used to authenticate the Exporter with the OTLP gRPC Receiver.
{"type": "object"}
hws-config.json
trustedCertificatesFile
Sets Hardware Sentry's OTLP Exporter trusted certificates file (Default: security/otel.crt).
{"type": "string", "default": "security/otel.crt"}
hws-config.json
endpoint
Configures the OTLP Receiver endpoint (Default: https://localhost:4317).
{"type": "string", "default": "https://localhost:4317"}
hws-config.json
extraLabels
Adds or overrides the attributes for all the monitored hosts. It is recommended to specify a different `site` label value for each OpenTelemetry Collector running the Hardware Sentry Agent.
{}
hws-config.json
extraMetrics
Adds additional static metrics to be exposed by Hardware Sentry.
{"type": "object", "propertyNames": {"pattern": "^[A-Za-z0-9_.-]+$"}, "patternProperties": {".*": {"type": "number"}}}
hws-config.json
hardwareProblemTemplate
Overrides the default hardware problem template used to build the alert body for all the monitored hosts.
{}
hws-config.json
hosts
Configures the hosts to monitor.
{"type": "array", "items": {"type": "object", "properties": {"collectPeriod": {"default": "2m"}, "disableAlerts": {"type": "boolean", "default": false}, "discoveryCycle": {"type": "integer", "default": "30"}, "excludedConnectors": {"type": "array", "items": {"type": "string"}}, "extraLabels": {}, "hardwareProblemTemplate": {}, "host": {"type": "object", "properties": {"hostname": {"type": "string"}, "id": {"type": "string"}, "type": {}}, "required": ["hostname", "type"]}, "hostGroup": {"type": "object", "properties": {"hostnames": {"oneOf": [{"type": "array", "items": {"type": "string"}}, {"type": "object", "patternProperties": {"^[A-Za-z0-9.\\-_:]+$": {"type": "object", "properties": {"extraLabels": {}}}}}]}, "type": {}}, "required": ["hostnames", "type"]}, "http": {"type": "object", "properties": {"https": {"type": "boolean", "default": true}, "password": {"type": "string"}, "port": {"type": "integer", "default": 443}, "timeout": {"default": "120s"}, "username": {"type": "string"}}}, "ipmi": {"type": "object", "properties": {"password": {"type": "string"}, "timeout": {"default": "120s"}, "username": {"type": "string"}}}, "loggerLevel": {}, "operationTimeout": {"type": "integer"}, "osCommand": {"type": "object", "properties": {"sudoCommand": {"type": "string", "default": "sudo"}, "timeout": {"default": "120s"}, "useSudo": {"type": "boolean", "default": false}, "useSudoCommands": {"type": "array", "items": {"type": "string"}}}}, "outputDirectory": {}, "selectedConnectors": {"type": "array", "items": {"type": "string"}}, "sequential": {}, "snmp": {"type": "object", "properties": {"community": {"type": "string", "default": "public"}, "password": {"type": "string"}, "port": {"type": "integer", "default": 161}, "privacy": {"type": "string", "enum": ["none", "aes", "des"]}, "privacyPassword": {"type": "string"}, "timeout": {"default": "120s"}, "username": {"type": "string"}, "version": {"type": "string", "enum": ["v1", "v2c", "v3-no-auth", "v3-md5", "v3-sha"], "default": "v1"}}}, "ssh": {"type": "object", "properties": {"password": {"type": "string"}, "privateKey": {"type": "string"}, "sudoCommand": {"type": "string", "default": "sudo"}, "timeout": {"default": "120s"}, "useSudo": {"type": "boolean", "default": false}, "useSudoCommands": {"type": "array", "items": {"type": "string"}}, "username": {"type": "string"}}}, "wbem": {"type": "object", "properties": {"namespace": {}, "password": {"type": "string"}, "port": {"type": "integer", "default": 5989}, "protocol": {"default": "https"}, "timeout": {"default": "120s"}, "username": {"type": "string"}}}, "winrm": {"type": "object", "properties": {"authentications": {"type": "array", "items": {"type": "string", "enum": ["ntlm", "kerberos"]}, "default": ["ntlm"]}, "namespace": {}, "password": {"type": "string"}, "port": {"type": "integer"}, "protocol": {"default": "http"}, "timeout": {"default": "120s"}, "username": {"type": "string"}}}, "wmi": {"type": "object", "properties": {"namespace": {}, "password": {"type": "string"}, "timeout": {"default": "120s"}, "username": {"type": "string"}}}}, "oneOf": [{"required": ["host"]}, {"required": ["hostGroup"]}]}}
hws-config.json
collectPeriod
Sets the default collect period that Hardware Sentry uses to collects metrics from the monitored host (Default: 2m).
{"default": "2m"}
hws-config.json
disableAlerts
Disables Hardware Sentry's alerts for the monitored host (Default: false).
{"type": "boolean", "default": false}
hws-config.json
discoveryCycle
Sets the cycle that Hardware Sentry uses to perform discoveries and detect new components for the specific host. By default, Hardware Sentry runs a discovery after 30 collects.
{"type": "integer", "default": "30"}
hws-config.json
excludedConnectors
Sets the Connector(s) that must be excluded from the automatic detection.
{"type": "array", "items": {"type": "string"}}
hws-config.json
extraLabels
Adds or overrides the attributes of the monitored host.
{}
hws-config.json
hardwareProblemTemplate
Overrides the default hardware problem template used to build the alert body for the monitored host.
{}
hws-config.json
host
Configures a new host to be monitored.
{"type": "object", "properties": {"hostname": {"type": "string"}, "id": {"type": "string"}, "type": {}}, "required": ["hostname", "type"]}
hws-config.json
hostname
Configures the hostname of the host to be monitored.
{"type": "string"}
hws-config.json
id
Configures the identifier of the host to be monitored (Optional). By default, the host identifier is the hostname property value.
{"type": "string"}
hws-config.json
type
Configures the type of the host to be monitored.
{}
hws-config.json
hostGroup
Configures several hosts which share the same characteristics.
{"type": "object", "properties": {"hostnames": {"oneOf": [{"type": "array", "items": {"type": "string"}}, {"type": "object", "patternProperties": {"^[A-Za-z0-9.\\-_:]+$": {"type": "object", "properties": {"extraLabels": {}}}}}]}, "type": {}}, "required": ["hostnames", "type"]}
hws-config.json
hostnames
Configures the hostnames of the hosts to be monitored.
{"oneOf": [{"type": "array", "items": {"type": "string"}}, {"type": "object", "patternProperties": {"^[A-Za-z0-9.\\-_:]+$": {"type": "object", "properties": {"extraLabels": {}}}}}]}
hws-config.json
^[A-Za-z0-9.\-_:]+$
Configures the hostname of the host to be monitored.
{"type": "object", "properties": {"extraLabels": {}}}
hws-config.json
extraLabels
Adds or overrides the attributes of the monitored host.
{}
hws-config.json
type
Configures the type of the hosts to be monitored.
{}
hws-config.json
http
Configures the HTTP protocol to access the host.
{"type": "object", "properties": {"https": {"type": "boolean", "default": true}, "password": {"type": "string"}, "port": {"type": "integer", "default": 443}, "timeout": {"default": "120s"}, "username": {"type": "string"}}}
hws-config.json
https
Enables HTTPS to access the host (Default: true).
{"type": "boolean", "default": true}
hws-config.json
password
Sets the password used to establish the connection with the host through the HTTP protocol.
{"type": "string"}
hws-config.json
port
Sets the HTTPS port number used to perform HTTP requests (Default: 443).
{"type": "integer", "default": 443}
hws-config.json
timeout
Sets how long until the HTTP request times out (Default: 120s).
{"default": "120s"}
hws-config.json
username
Sets the username used to establish the connection with the host through the HTTP protocol.
{"type": "string"}
hws-config.json
ipmi
Configures the IPMI protocol to access the host.
{"type": "object", "properties": {"password": {"type": "string"}, "timeout": {"default": "120s"}, "username": {"type": "string"}}}
hws-config.json
password
Sets the password used to establish the connection with the host through the IPMI protocol.
{"type": "string"}
hws-config.json
timeout
Sets how long until the IPMI request times out (Default: 120s).
{"default": "120s"}
hws-config.json
username
Sets the username used to establish the connection with the host through the IPMI protocol.
{"type": "string"}
hws-config.json
loggerLevel
Enables the debug mode of the core engine on the specific host (Default: off).
{}
hws-config.json
operationTimeout
Sets how long until the engine's discovery and collect operations time out.
{"type": "integer"}
hws-config.json
osCommand
Configures the OS Command protocol to access the host.
{"type": "object", "properties": {"sudoCommand": {"type": "string", "default": "sudo"}, "timeout": {"default": "120s"}, "useSudo": {"type": "boolean", "default": false}, "useSudoCommands": {"type": "array", "items": {"type": "string"}}}}
hws-config.json
sudoCommand
Sets the sudo command to be used for the host to be monitored (Default: sudo).
{"type": "string", "default": "sudo"}
hws-config.json
timeout
Sets how long until the local OS Command times out (Default: 120s).
{"default": "120s"}
hws-config.json
useSudo
Sets if sudo needs to be used for the local OS Command (Default: false).
{"type": "boolean", "default": false}
hws-config.json
useSudoCommands
Sets the list of commands for which sudo is required.
{"type": "array", "items": {"type": "string"}}
hws-config.json
outputDirectory
Sets the debug output directory for the monitored host. By default, the debug output file is saved in the `logs` directory under the Hardware Sentry's home directory.
{}
hws-config.json
selectedConnectors
Sets the Connector(s) to use to monitor the host. No automatic detection will be performed.
{"type": "array", "items": {"type": "string"}}
hws-config.json
sequential
Forces all the network calls to be executed in sequential order for the monitored host - NOT RECOMMENDED (Default: false).
{}
hws-config.json
snmp
Configures the SNMP protocol to access the host.
{"type": "object", "properties": {"community": {"type": "string", "default": "public"}, "password": {"type": "string"}, "port": {"type": "integer", "default": 161}, "privacy": {"type": "string", "enum": ["none", "aes", "des"]}, "privacyPassword": {"type": "string"}, "timeout": {"default": "120s"}, "username": {"type": "string"}, "version": {"type": "string", "enum": ["v1", "v2c", "v3-no-auth", "v3-md5", "v3-sha"], "default": "v1"}}}
hws-config.json
community
Sets the SNMP Community string to use to perform SNMP v1 queries (Default: public).
{"type": "string", "default": "public"}
hws-config.json
password
SNMP v3 only - Sets the password to use for performing the SNMP query.
{"type": "string"}
hws-config.json
port
Sets the SNMP port number used to perform SNMP queries (Default: 161).
{"type": "integer", "default": 161}
hws-config.json
privacy
SNMP v3 only - Sets the type of encryption protocol.
{"type": "string", "enum": ["none", "aes", "des"]}
hws-config.json
privacyPassword
SNMP v3 only - Sets the password associated to the privacy protocol.
{"type": "string"}
hws-config.json
timeout
Sets how long until the SNMP request times out (Default: 120s).
{"default": "120s"}
hws-config.json
username
SNMP v3 only - Sets the username to use for performing the SNMP query.
{"type": "string"}
hws-config.json
version
Sets the version of the SNMP protocol (Default: v1).
{"type": "string", "enum": ["v1", "v2c", "v3-no-auth", "v3-md5", "v3-sha"], "default": "v1"}
hws-config.json
ssh
Configures the SSH protocol to access the host.
{"type": "object", "properties": {"password": {"type": "string"}, "privateKey": {"type": "string"}, "sudoCommand": {"type": "string", "default": "sudo"}, "timeout": {"default": "120s"}, "useSudo": {"type": "boolean", "default": false}, "useSudoCommands": {"type": "array", "items": {"type": "string"}}, "username": {"type": "string"}}}
hws-config.json
password
Sets the password to use for performing the SSH query.
{"type": "string"}
hws-config.json
privateKey
Sets the private Key File to use to establish the connection to the host through the SSH protocol.
{"type": "string"}
hws-config.json
sudoCommand
Sets the sudo command to be used.
{"type": "string", "default": "sudo"}
hws-config.json
timeout
Sets how long until the command times out (Default: 120s).
{"default": "120s"}
hws-config.json
useSudo
Sets if sudo needs to be used for the SSH Command (Default: false).
{"type": "boolean", "default": false}
hws-config.json
useSudoCommands
Sets the list of commands for which sudo is required.
{"type": "array", "items": {"type": "string"}}
hws-config.json
username
Sets the username to use for performing the SSH query.
{"type": "string"}
hws-config.json
wbem
Configures the WBEM protocol to access the host.
{"type": "object", "properties": {"namespace": {}, "password": {"type": "string"}, "port": {"type": "integer", "default": 5989}, "protocol": {"default": "https"}, "timeout": {"default": "120s"}, "username": {"type": "string"}}}
hws-config.json
password
Sets the password used to establish the connection with the host through the WBEM protocol.
{"type": "string"}
hws-config.json
port
Sets the HTTPS port number used to perform WBEM queries (Default: 5989 for HTTPS or 5988 for HTTP).
{"type": "integer", "default": 5989}
hws-config.json
protocol
Sets the protocol used to access the host (Default: https).
{"default": "https"}
hws-config.json
timeout
Sets how long until the WBEM request times out (Default: 120s).
{"default": "120s"}
hws-config.json
username
Sets the username used to establish the connection with the host through the WBEM protocol.
{"type": "string"}
hws-config.json
winrm
Configures the WinRM protocol to access the host.
{"type": "object", "properties": {"authentications": {"type": "array", "items": {"type": "string", "enum": ["ntlm", "kerberos"]}, "default": ["ntlm"]}, "namespace": {}, "password": {"type": "string"}, "port": {"type": "integer"}, "protocol": {"default": "http"}, "timeout": {"default": "120s"}, "username": {"type": "string"}}}
hws-config.json
authentications
Sets an ordered list of authentication schemes (Default: ["ntlm"]).
{"type": "array", "items": {"type": "string", "enum": ["ntlm", "kerberos"]}, "default": ["ntlm"]}
hws-config.json
password
Sets the password used to establish the connection with the host through the WinRM protocol.
{"type": "string"}
hws-config.json
port
Sets the port number used to perform WQL queries and commands (Default: 5985 for HTTP or 5986 for HTTPS).
{"type": "integer"}
hws-config.json
protocol
Sets the protocol used to access the host (Default: http).
{"default": "http"}
hws-config.json
timeout
Sets how long until the WinRM request times out (Default: 120s).
{"default": "120s"}
hws-config.json
username
Sets the username used to establish the connection with the host through the WinRM protocol.
{"type": "string"}
hws-config.json
wmi
Configures the WMI protocol to access the host.
{"type": "object", "properties": {"namespace": {}, "password": {"type": "string"}, "timeout": {"default": "120s"}, "username": {"type": "string"}}}
hws-config.json
password
Sets the password used to establish the connection with the host through the WMI protocol.
{"type": "string"}