key: npmRepository

description: Name of the nexus repository for NPM artifacts. Ignored if the project does not contain a package.json in the project root directory.


key: whitesourceScan

description:
Configure credentials for WhiteSource scans. The minimum required Maven WhiteSource plugin version is 18.6.2, ensure this in the plugins section of the project pom.xml file.

Pipeline will execute npx whitesource run for npm projects. Please ensure that all package.json files have a name and version configured so that it is possible to distinguish between the different packages.

type: object

type: string

required: product credentialsId


key: product

description: Name of your product in WhiteSource.


key: staticVersion

description: Overwrites the respective version in the whitesource UI per scan with the staticVersion. Per default for every new version of a pom/package.json a new project will be created in the whitesource UI. To deactivate the creation of new projects and always have a fixed version for each project in the whitesource UI, configure the staticVersion.


key: whitesourceUserTokenCredentialsId

description: Unique identifier of the Secret Text on Jenkins server that stores WhiteSource userKey of a user. This is required only if the administrator of the WhiteSource service has enabled additional access level control. More details can be found here.


key: sourceClearScan

description: Configure SourceClear scans.Note: Please note that the SourceClear stage of this pipeline is not actively maintained anymore. In case of issues, feel free to contribute to this project by opening a pull request.


key: config

description: Additional configuration for the SourceClear agent. The key-value pairs will be added to srcclr.yml.


key: compliance

description: Configure the stage Compliance, which currently executes a SonarQube (https://www.sonarqube.org/) scan.

type: boolean


key: runInAllBranches

description: Define whether the scan should also happen in non productive branches, i.e. if your SonarQube instance supports that.


key: mavenExecute

description: The mavenExecute step is used for all invocations of the mvn build tool. It is either used directly for executing specific maven phases such as test, or indirectly for steps that execute maven plugins such as checkPmd.


key: projectSettingsFile

description: The project settings.xml to be used for maven builds. You can specify a relative path to your project root or a URL starting with http or https.


key: artifactPrepareVersion

description: If automatic versioning is enabled, this step is used to set a common version for artifacts and optionally push a corresponding tag.

default: true

default: false


key: commitUserName

description: Defines the user name which appears in version control for the versioning update (in case versioningType: cloud).


key: includeCommitId

description: Defines if the automatically generated version (versioningType: cloud) should include the commit id hash.


key: tagPrefix

description: Defines the prefix which is used for the git tag which is written during the versioning run (only versioningType: cloud).


key: unixTimestamp

description: Defines if the Unix timestamp number should be used as build number instead of the standard date format.


key: versioningType

description: Defines the type of versioning (cloud: fully automatic, cloud_noTag: automatic but no tag created, library: manual)


key: executeNpm

description: The executeNpm step is used for all invocations of the npm build tool. It is, for example, used for building the frontend and for executing end to end tests.


key: defaultNpmRegistry

description: The default npm registry url to be used as the remote mirror. Bypasses the local download cache if specified.


key: cloudFoundryDeploy

description: A step configuration regarding Cloud Foundry deployment. This is required by stages like end-to-end tests, performance tests, and production deployment.

type: integer


key: smokeTestStatusCode

description: Expected return code for smoke test success.


key: keepOldInstance

description: In case of a blue-green deployment the old instance will be stopped and will remain in the Cloud Foundry space by default. If this option is set to false, the old instance will be deleted.


key: neo

description: The map for neo.

required: host account application runtime runtimeVersion


key: checkGatling

description: Gatling is used as one of the performance tests tool.


key: enabled

description: You can enable Gatling tests by turning the flag to true.


key: checkJMeter

description: Apache JMeter is executed as part of performance tests of the application. The user is free to choose between JMeter and Gatling or both.

default: famiko/jmeter-base


key: options

description: Options such as proxy.


key: testPlan

description: The directory where the test plans reside. Should reside in a subdirectory under performance-tests directory if both JMeter and Gatling are enabled.


key: failThreshold

description: Marks build as FAILURE if the value exceeds the threshold.


key: unstableThreshold

description: Marks build as UNSTABLE if the value exceeds the threshold.


key: verbose

description: Sends the verbose output to the Jenkins log.


key: fortifyCredentialsId

description: Jenkins 'Secret text' credentials ID containing token to authenticate to Fortify SSC.


key: githubTokenCredentialsId

description: Jenkins 'Secret text' credentials ID containing token to authenticate to GitHub.


key: serverUrl

description: Fortify SSC Url to be used for accessing the APIs


key: projectName

description: The project used for reporting results in SSC


key: defaultVersioningModel

description: The default project versioning model used in case 'projectVersion' parameter is empty for creating the version based on the build descriptor version to report results in SSC, can be one of 'major', 'major-minor', 'semantic', 'full'

default: major


key: buildTool

description: Scan type used for the step which can be 'maven', 'pip'

default: maven


key: autoCreate

description: Whether Fortify project and project version shall be implicitly auto created in case they cannot be found in the backend


key: uploadResults

description: Whether results shall be uploaded or not


key: memory

description: The amount of memory granted to the translate/scan executions

default: -Xmx4G -Xms512M


key: src

description: A list of source directories to scan. Wildcards can be used, e.g., 'src/main/java/**/*'. The default value for buildTool: 'maven' is ['**/*.xml', '**/*.html', '**/*.jsp', '**/*.js', '**/src/main/resources/**/*', '**/src/main/java/**/*'], for buildTool: 'pip' it is ['./**/*'].

type: array


key: exclude

description: A list of directories/files to be excluded from the scan. Wildcards can be used, e.g., '**/Test.java'.


key: whitesourceExecuteScan

description:
Configure credentials for WhiteSource scans. The minimum required Maven WhiteSource plugin version is 18.6.2, ensure this in the plugins section of the project pom.xml file.

Pipeline will execute npx whitesource run for npm projects. Please ensure that all package.json files have a name configured so that it is possible to distinguish between the different packages.


key: productName

description: Name of your product in WhiteSource.


key: productVersion

description: Overwrites the project version in the WhiteSource UI per scan with the given version. Per default, the version from the main build descriptor file is used and transformed according to the versioningModel parameter, i.e. "1" for the default model of "major".


key: userTokenCredentialsId

description: Unique identifier of the Secret Text on Jenkins server that stores WhiteSource userKey of a user. This is required only if the administrator of the WhiteSource service has enabled additional access level control. More details can be found here.


key: buildTarget

description: The target platform to which the mtar can be deployed.

default: NEO


key: mtaBuildTool

description: Choose which tool is used to build your mta project. The default option is `cloudMbt` which is not backwards compatible with the `classic` tool. For more information on migrating from `classic` to `cloudMbt`, please refer to https://sap.github.io/cloud-mta-build-tool/migration/.

default: cloudMbt


key: applicationName

description: The name of the application which is being built. If the parameter has been provided and no mta.yaml exists, the mta.yaml will be automatically generated using this parameter and the information (name and version) from package.json before the actual build starts.


key: defaultNpmRegistry

description: Url to the npm registry that should be used for installing npm dependencies.


key: dockerOptions

description: Docker options to be set when starting the container (List or String).

type: array string


key: extension

description: The path to the extension descriptor file.


key: globalSettingsFile

description: Path or url to the mvn settings file that should be used as global settings file.


key: projectSettingsFile

description: Path or url to the mvn settings file that should be used as project settings file.


key: mtaJarLocation

description: The location of the SAP Multitarget Application Archive Builder jar file, including file name and extension. If it is not provided, the SAP Multitarget Application Archive Builder is expected on PATH.


key: debugReportArchive

description: The debugReportArchive configuration can be used to create confidential (instead of redacted) debug reports. The difference between the redacted and the confidential debug report is that potentially confidential information, such as the GitHub repository and branch, global extension repository and shared libraries, are included in the confidential debug report. It is the user's responsibility to make sure that the debug report does not contain any confidential information.


key: shareConfidentialInformation

description: If set to true, a confidential debug report is being generated with each build.


key: sonarExecuteScan

description: Configure SonarQube (https://www.sonarqube.org/) scans.

required: projectKey instance


key: projectKey

description: The project key is used to refer your project.


key: instance

description: This property refers to a SonarQube instance, which needs to be defined in the Jenkins.


key: options

description: A list of additional options (in the form of '-Dxy=z') to be passed to the sonar scanner tool.


key: tmsUpload

description: This step allows you to upload an MTA file (multi-target application archive) and multiple MTA extension descriptors into a TMS (SAP Cloud Platform Transport Management Service) landscape for further TMS-controlled distribution through a TMS-configured landscape.

default: <Corresponding Git Commit-ID>


key: nodeName

description: Defines the name of the node to which the *.mtar file should be uploaded.


key: credentialsId

description: Credentials to be used for the file and node uploads to the Transport Management Service.


key: customDescription

description: Can be used as the description of a transport request. Will overwrite the default.


key: scale

description: Discretizing scales

enum: quantile quantize threshold bin-ordinal

enum: width height symbol category ordinal ramp diverging heatmap

type: number


description: Default numeric scale

enum: ordinal band point quantile quantize threshold sequential pow log time utc identity bin-ordinal bin-linear


description: Schema definition for Localazy CLI configuration file.

type: string array object number boolean

type: array object

enum: file project none

enum: android json arb ios-strings ios-plist ios-stringsdict xliff resx yaml po pot json5 hjson js properties ini php qt-ts text csv neon toml excel ods srt

type: string array

type: string array object

default: inherited

type: string object

enum: android arb csv csv-multilingual excel excel-multilingual ini ini-multilingual ios-strings ios-stringsdict json json-mozilla json-multilingual mo neon neon-multilingual ods ods-multilingual php php-multilingual po toml toml-multilingual yaml yaml-multilingual yaml-rails


key: $schema


key: writeKey

description: Your project's write key. It can be found in Settings -> Access keys.


key: readKey

description: Your project's read key. It can be found in Settings -> Access keys.


key: branch

description: The branch to perform the operation on. If not specified, the operation is performed on the project corresponding to write/read key.


key: community

description: Define community settings for sharing your configuration with other users. https://localazy.com/docs/cli/community-sharing


key: author

description: The name of the author of the script.


key: email

description: The email of the author of the script. It's not available publicly.


key: company

description: Company name if applicable.


key: website

description: Website name if applicable.


key: tags

description: A set of tags to help other users find your script. Please tag your technology stack, framework, library, programming language, etc.


key: description

description: The description of the script. Please describe what the script does and how it works.


key: transformations

description: The transformations property allows defining rules for string transformations. Using transformations, you can, e.g., obtain locale code from its file path or build the specific path where to write translated files. https://localazy.com/docs/cli/transformations


key: upload

description: The upload section defines how to collect files that you want to upload to the Localazy platform for localization and what metadata to include. It also defines how to process uploaded data. https://localazy.com/docs/cli/upload-reference


key: deprecateMissing

description: Tells the server to deprecate any phrase missing in this upload batch. Deprecated phrases are still available but are not visible to translators.


key: deprecate


key: importAsNew

description: Tells the server to import new phrases as unverified. Unverified phrases need to go through the review process. This option allows you to check translations using our unique review process if you are not sure of their quality. This option doesn’t apply to the source language.


key: allowDuplicateKeys

description: By default, you can have phrases with the same key in different files. For specific situations like using libraries and string overriding, it’s necessary to disable this option. You can find more on this topic in 'Modules, libraries, product flavors' article.


key: skipFailedAutodetection

description: When set to true files that use auto-detection are skipped if the auto-detection is not possible. When set to false an exception is raised.


key: filterSource

description: When set to true, strings that are the same as in the source langauge are not imported. This is important for platforms like iOS where localizable files contain the source phrase where the translation is not available. This option doesn’t apply to the source language.


key: forceCurrent

description: Tells the server to promote changes in translated files as approved and current translations for phrases that are already translated. If set to false, such changes go to the review process.


key: appVersion

description: Tells the server the version of the app in which the phrases where deprecated. It only makes sense with deprecateMissing switched to true. It allows for automatic versioning of deprecated phrases. This option can be provided on the command-line with -v option.


key: type

description: Type of files you are about to upload. You can also define the type separately for each file. For more info about supported file formats check out the documentation.


key: folder

description: The base folder all operations are relative to. It can be relative or absolute path.


key: features

description: The list of features (eg. how to parse plurals) to enable for the given type. See the list of supported file formats in documentation for more information. https://localazy.com/docs/cli/upload-reference#supported-file-formats


key: keySeparator

description: The separator used for building structured keys for includeKeys and excludeKeys. For more details: https://localazy.com/docs/cli/excluding-string-keys


key: includeKeys

description: A list of rules for determining keys to include. For more details: https://localazy.com/docs/cli/excluding-string-keys


key: excludeKeys

description: A list of rules for determining keys to exclude. For more details: https://localazy.com/docs/cli/excluding-string-keys


key: files

description: The files contains a list of rules for collecting files for upload. You can include files by their exact path or by using standard path wildcards ? (single character), * (anything except path separator), ** (anything including path separators). You can control files that you want to upload with exclusion rules and conditions.


key: conversion

description: The conversion property describes how to convert localizable files between different formats. https://localazy.com/docs/cli/format-conversions#full-configuration


key: excludedLangs

description: The list of languages to exclude from processing.


key: actions

description: Define the conversion rules.


key: download

description: The download property describes how to process translated files and where to write them. https://localazy.com/docs/cli/download-reference


key: includeSourceLang

description: By default, the source language is not downloaded. Set it to true to include source files as well.


description: Base folder for the download action. It can be relative or absolute path.


key: metadataFileJson

description: Path where JSON language metadata file should be downloaded. https://localazy.com/docs/cli/metadata-file


key: metadataFileJs

description: Path where JavaScript language metadata file should be downloaded. https://localazy.com/docs/cli/metadata-file


key: metadataFileTs

description: Path where TypeScript language metadata file should be downloaded. https://localazy.com/docs/cli/metadata-file


key: langAliases

description: Maps languages to different ones.


key: langExpansions

description: Adds additional languages to output; the same file will be saved several time.


description: The rules to apply to all translated files. It can be either array object or a pattern string.


key: name

description: The name of the newly created variable. It will be accessible as ${name}. https://localazy.com/docs/cli/variables


key: source

description: The source of the variable. Usually, it's a string consisting of other variables. https://localazy.com/docs/cli/variables


key: operations

description: The operations to perform on the source string to get the new variable. https://localazy.com/docs/cli/transformations#operations


key: type

description: Type of files you are about to upload. For more info about supported file formats check out the documentation. https://localazy.com/docs/cli/upload-reference


key: features

description: The list of features (eg. how to parse plurals) to enable for the given type. See the list of supported file formats in documentation for more information. https://localazy.com/docs/cli/upload-reference#supported-file-formats


key: lang

description: The language of the file being uploaded (format: ll-Scrp-RR). Special default value inherited from the project’s base language.


key: group

description: Allows to assign files to groups and run their rules separately.


key: buildType

description: The custom build type for the file. See Modules, libraries, flavors for more details. https://localazy.com/docs/cli/modules-libraries-product-flavors#build-type


key: productFlavors

description: The custom product flavors for the file. See Modules, libraries, flavors for more details. https://localazy.com/docs/cli/modules-libraries-product-flavors#product-flavors


key: module

description: The module the file belongs to. See Modules, libraries, flavors for more details. https://localazy.com/docs/cli/modules-libraries-product-flavors#module


key: library

description: The library the file belongs to. See Modules, libraries, flavors for more details. https://localazy.com/docs/cli/modules-libraries-product-flavors#library


key: path

description: The path to be used for upload.


key: file

description: The file name to be used for upload.


key: pattern

description: The pattern to use for collecting files. Standard path wildcards ? (single character), * (anything except path separator), ** (anything including path separators) are supported.


key: excludes

description: The list of patterns used for excluding files. Standard path wildcards ? (single character), * (anything except path separator), ** (anything including path separators) are supported.


key: conditions

description: With conditions, you can introduce complex logic for processing files when they are downloaded. See documentation for options. https://localazy.com/docs/cli/conditions


key: keySeparator

description: The separator used for building structured keys for includeKeys and excludeKeys. For more details: https://localazy.com/docs/cli/excluding-string-keys


key: includeKeys

description: A list of rules for determining keys to include. For more details: https://localazy.com/docs/cli/excluding-string-keys


key: excludeKeys

description: A list of rules for determining keys to exclude. For more details: https://localazy.com/docs/cli/excluding-string-keys


key: replacements

description: Define rules for text changes and placeholder replacements.


key: langAliases

description: Maps languages to different ones.


key: langExpansions

description: Adds additional languages to output; the same file will be saved several time.


key: stop

description: If true, no more rules are processed for the given file. Only makes sense if more output rules are defined. By default, the first matching rule stops processing for the file.


key: changeExtension

description: If defined, change the extension of the output file. Applied to the final output after resolving all variables.


key: output

description: The pattern for generating output path and file. Use variables to build the pattern. https://localazy.com/docs/cli/variables


key: type

description: The type of the conversion to be performed with files. See docs for available types and their parameters. https://localazy.com/docs/cli/format-conversions#available-conversions


key: arrayType

description: If the type supports more formats for string arrays, you can select the desired one with this parameter.


key: pluralType

description: If the type supports more formats for plurals, you can select the desired one with this parameter.


key: forceArrayType

description: If the conversion is made between types that support the same format for string arrays, the format is retained unless you explicitly set this parameter to true to force change.


key: forcePluralType

description: If the conversion is made between types that support the same format for plurals, the format is retained unless you explicitly set this parameter to true to force change.


key: filterStrings

description: If the conversion type allows filtering, you can enable this option to filter strings out of the output file.


key: filterArrays

description: If the conversion type allows filtering, you can enable this option to filter string arrays out of the output file.


key: filterPlurals

description: If the conversion type allows filtering, you can enable this option to filter plurals out of the output file.


key: params

description: Some of the conversion types support additional parameters. See documentation for details.


key: group

description: Allows to assign files to groups and run their rules separately.


key: conditions

description: With conditions, you can introduce complex logic for processing files when they are downloaded. See documentation for options. https://localazy.com/docs/cli/conditions


description: The pattern for generating output path and file. Use variables to build the pattern.


key: name

description:
Name of the custom analyzer.
Names must be unique within an index, and may not start with any of the following strings:
- lucene.
- builtin.
- mongodb.


key: charFilters

description: Array containing zero or more character filters.


key: tokenFilters

description: Array containing zero or more token filters.


key: Tokenizer

description: Tokenizer to use to create tokens.

enum: edgeGram keyword nGram regexCaptureGroup regexSplit standard uaxUrlEmail whitespace


description: Human-readable label that identifies this token filter type.

enum: asciiFolding daitchMokotoffSoundex edgeGram icuFolding icuNormalizer length lowercase nGram regex reverse shingle snowballStemming stopword trim


description: Human-readable label that identifies this character filter type.

enum: htmlStrip icuNormalize mapping persian


key: ignoredTags

description: List that contains the HTML tags to exclude from filtering.


key: Mappings

description: Specifies how to index fields at different paths for this index.


key: dynamic

description:
Enables or disables dynamic mapping of fields for this index.
If set to true, Atlas Search recursively indexes all fields and embedded documents in the document except:
Fields of certain data types. To learn more, see BSON Data Types.
Any fields explicitly excluded by the mappings.fields parameter.
If set to false, you must specify individual fields to index using mappings.fields.
If omitted, defaults to false.


key: include

description:
List that contains the field names or dot-separated paths to fields to store.
In addition to the specified fields, Atlas Search stores _id also by default.


key: exclude

description:
List that contains the field names or dot-separated paths to fields to exclude from being stored.
If specified, Atlas Search stores original documents except the fields listed here.


key: analyzer

description:
Specifies the analyzer to apply to string fields when indexing.
If you set this only at the top and do not specify an analyzer for the fields in the index definition, Atlas Search applies this analyzer to all the fields.
To use a different analyzer for each field, you must specify a different analyzer for the field.
If omitted, defaults to Standard Analyzer.


key: analyzers

description: Specifies the Custom Analyzers to use in this index.


description:
Specifies a name for the index. In each namespace, names of all indexes in the namespace must be unique.
If omitted, defaults to default.


key: searchAnalyzer

description:
Specifies the analyzer to apply to query text before searching with it.
If omitted, defaults to Standard Analyzer.


key: storedSource

description:
Specifies fields in the documents to store for query-time look-ups using the returnedStoredSource option.
You can store fields of all BSON Data Types on Atlas Search.

Value can be one of the following:
true, to store all fields
false, to not store any fields
Object that specifies the fields to include or exclude from storage

If omitted, defaults to false.


key: synonyms

description: Synonym mappings to use in your index.


description: Application Router Configuration Schema

format: regex

format: relative-uri

format: route-rules

enum: DELETE GET HEAD OPTIONS POST PUT TRACE PATCH

enum: xsuaa basic none

format: valid-header-value

format: destinations-rules

enum: PUT POST GET

format: services-rules

format: logout-rules

format: uri

required: status file

type: integer array

format: local-file


key: newProjectRoot

description: Path where new projects will be created.


key: schematicCollections

description: The list of schematic collections to use.


key: packageManager

description: Specify which package manager tool to use.

enum: npm cnpm yarn pnpm


key: warnings

description: Control CLI specific console warnings


key: versionMismatch

description: Show a warning when the global version is newer than the local one.


key: analytics

description: Share pseudonymous usage data with the Angular Team at Google.

type: boolean string


key: cache

description: Control disk cache.

enum: local ci all


key: environment

description: Configure in which environment disk cache is enabled.


key: enabled

description: Configure whether disk caching is enabled.


key: path

description: Cache base path.


key: completion

description: Angular CLI completion settings.


key: prompted

description: Whether the user has been prompted to add completion command prompt.


key: fileVersion

description: File format version


key: prefix

description: The prefix to apply to generated selectors.

format: html-selector


key: root

description: Root of the project files.


key: sourceRoot

description: The root of the source files, assets and index.html file structure.


key: projectType

description: Project type.

enum: application library


description: Project i18n options

default: en-US


key: sourceLocale

description: Specifies the source locale of the application.


description: Localization options to use for the source locale


key: code

description: Specifies the locale code of the source locale


key: baseHref

description: HTML base HREF to use for the locale (defaults to the locale code)


description: Localization file to use for i18n


description: Localization files to use for i18n


description: Localization options to use for the locale


key: translation

description: Localization file to use for i18n


description: Localization files to use for i18n


key: builder

description: The builder used for this package.


key: defaultConfiguration

description: A default named configuration to use when a target configuration is not provided.


key: configurations

description: A map of alternative target options.


description: JSON schema for Paper Plugin YAML

enum: true false op notop

enum: AFTER BEFORE OMIT

enum: STARTUP POSTWORLD

required: name version main api-version


key: permission

description: A permission for this plugin


key: default

description: Default for this permission


key: additionalProperties

description: False to not inherit the parent permission.


key: dependency

description: A plugin dependency


key: load

description: Where to load this dependency in relation to the plugin. Defaults to OMIT


key: join-classpath

description: Whether this dependency's classpath should be joined by the plugin. Defaults to true


key: required

description: Whether this dependency is required for the plugin to load. Defaults to true


key: name

description: The name of the plugin


key: main

description: The main class of the plugin


key: bootstrapper

description: The main class of the custom bootstrapper for the plugin


key: loader

description: The main class of the custom plugin loader for the plugin


key: provides

description: Satisfies dependency requirements as this plugin. When resolving dependencies, if a plugin requires a plugin in this list, this plugin will satisfy it.


key: has-open-classloader

description: Whether the plugin should have its classloader public to other paper plugins


key: version

description: The version of the plugin


key: description

description: The description of the plugin


key: authors

description: Main authors of the plugin


key: contributors

description: Other contributors to the plugin


key: website

description: Plugin website


key: prefix

description: Log prefix for this plugin. Defaults to the plugin name


description: When to load this plugin. Defaults to POSTWORLD.


key: default-perm

description: Default value for permissions. Defaults to 'op'


key: permissions

description: Permissions for this plugin


key: api-version

description: The API version of the plugin


key: dependencies

description: Plugin dependencies.


key: bootstrap

description: Depenencies for the plugin bootstrapper


key: server

description: Depenencies for the server


description: A language for a Minecraft resource pack config schema


description: This is a JSON schema representation of the schema.org Place schema: https://schema.org/Place

pattern: Place


description: override the @context property to ensure the schema.org URI is used


description: override the @type property to ensure Place is used


key: additionalProperty

description: A property-value pair representing an additional characteristics of the entity, e.g. a product feature or another characteristic for which there is no matching property in schema.org.


key: items

description: PropertyValue


key: address

description: PostalAddress


description: Physical address of the item.


key: aggregateRating

description: AggregateRating -- The overall rating, based on a collection of reviews or ratings, of the item.


key: amenityFeature

description: An amenity feature (e.g. a characteristic or service) of the Accommodation. This generic property does not make a statement about whether the feature is included in an offer for the main accommodation or available at extra costs.


description: LocationFeatureSpecification


key: branchCode

description: A short textual code (also called "store code") that uniquely identifies a place of business. The code is typically assigned by the parentOrganization and used in structured URLs.


key: containedInPlace

description: Place


key: containsPlace

description: Place


key: event

description: Event


key: faxNumber

description: The fax number.


key: geo

description: The geo coordinates of the place.


description: GeoCoordinates


description: GeoShape


key: globalLocationNumber

description: The Global Location Number (GLN, sometimes also referred to as International Location Number or ILN) of the respective organization, person, or place. The GLN is a 13-digit number used to identify parties and physical locations.


key: hasMap

description: A URL to a map of the place. Supersedes map, maps.


description: Map


description: The International Standard of Industrial Classification of All Economic Activities (ISIC), Revision 4 code for a particular organization, business person, or place.


key: logo

description: An associated logo.


description: ImageObject


key: openingHoursSpecification

description: OpeningHoursSpecification


key: photo

description: A photograph of this place. Supersedes photos.


description: ImageObject


description: Photograph


key: review

description: A review of the item. Supersedes reviews.


description: Review


key: smokingAllowed

description: Indicates whether it is allowed to smoke in the place, e.g. in the restaurant, hotel or hotel room.


key: specialOpeningHoursSpecification

description: The special opening hours of a certain place. Use this to explicitly override general opening hours brought in scope by openingHoursSpecification or openingHours.


key: items

description: OpeningHoursSpecification


key: telephone

description: The telephone number.


description: Used to validate Catapult Platform Support Pack (PSP) contents.yaml file, which provides an index of the files within the PSP

required: builtin path

required: vendor name description buildConfig version license documentationFile coreDescriptionFile launchConfig


key: supportPackFile

description: File within support pack


key: builtin

description: builtin="true" means that a file path is relative to the platform directory within the SDK installation.builtin="false" means the file path is relative to the top level of the unzipped package


key: path

description: file path within zip file


key: supportPackDirectory

description: Directory within support pack


description: directory path within zip file


key: platform

description: Catapult platform support file contents


key: vendor

description: Platform/device vendor name


key: name

description: Name of platform - used to identify platform in IDE


key: description

description: Full description of support pack


key: buildConfig

description: Value of the PLATFORM macro definition used during build


key: version

description: Support pack version


key: license

description: License text


key: documentationFile

description: Documentation file(s) - can be HTML or PDF


key: coreDescriptionFile

description: File containing description of core using IMG proprietary YAML format


key: peripheralRegisterDescriptionFile

description: File containing peripheral register information using CMSIS SVD XML format (see https://www.keil.com/pack/doc/CMSIS/SVD/html/svd_Format_pg.html)


key: openOCDConfigurationFile

description: File containing OpenOCD configuration (see https://openocd.org/doc-release/html/Config-File-Guidelines.html#Config-File-Guidelines)


key: launchConfig

description: Launch configuration for platform


key: gdbAutoRunCommandString

description: String with additional gdb commands to run to initiate connection to target


key: networkPortNumberForOCDConnections

description: TCP/IP port number for OpenOCD connections.  Set to "auto" to automatically use any free port


key: isPlatformFPGA

description: True only for FPGA platforms


key: fpgaBitFile

description: Bitfile for programming FPGA


key: fpgaProgConfigFile

description: OpenOCD config file for programming FPGA


key: traceSettingsString

description: String with processor trace encoder settings required by the decoder


key: libsDirectory

description: Directory containing library files for use with the platform


key: headersDirectory

description: Directory containing header files for use with the platform


key: remoteHost

description: Hostname or IP address for debug connection to remote machines


key: remoteUsername

description: Username for debug connection to remote machines


key: scriptId

description:
An ID of the current Google Apps Script project
https://github.com/google/clasp#scriptid-required


key: rootDir

description:
A root directory path of the current Google Apps Script project
https://github.com/google/clasp#rootdir-optional


key: projectId

description:
An ID for a Google Cloud Platform project linked to the current Google Apps Script project
https://github.com/google/clasp#projectid-optional

default: project-id-xxxxxxxxxxxxxxxxxxx


key: fileExtension

description:
An extension for local files of the current Google Apps Script project
https://github.com/google/clasp#filepushorder-optional


key: filePushOrder

description:
Files pushed first of the current Google Apps Script project
https://github.com/google/clasp#filepushorder-optional


key: items

description:
A file
https://github.com/google/clasp#filepushorder-optional


description: The name of your project. Used to label any images built.


description: Forbid reporting telemetry information for this project, even if the user has previously consented to telemetry.


key: containers

description: Definitions for each of the containers that make up your various environments


key: image

description: Image name (in standard Docker image reference format) to use for this container


description: Path (relative to the configuration file's directory) to a directory containing a Dockerfile to build and use as an image for this container


List of build args to use when building the image in build_directory


description: Dockerfile stage name to build and use for this container


List of SSH agents to forward to the image build process when building the image in build_directory


Secrets to expose to the image build process when building the image in build_directory


key: dockerfile

description: Dockerfile (relative to build_directory) to use when building the image. Defaults to Dockerfile if not set.


key: command

description: Command to run when the container starts


key: entrypoint

description: Entrypoint to use to run the command


key: environment

description: List of environment variables for the container


description: Working directory to start the container in


key: volumes

description: List of volume mounts to create for the container


key: ports

description: List of ports to make available to the host machine


key: dependencies

description: List of other containers that should be started and healthy before starting this container


Overrides health check configuration specified in the image or Dockerfile


key: privileged

description: Enable privileged mode for the container


description: Set to `true` to run an init process inside the container that forwards signals and reaps processes


List of additional capabilities to add to the container


List of additional capabilities to remove from the container


Hostnames to associate with this container in addition to the default hostname


description: Additional hostnames to add to /etc/hosts in the container


Commands to run after the container reports as healthy but before dependency containers start


description: Docker log driver to use


description: Additional options to pass to Docker log driver


description: Whether or not to pull image (including base image for containers that use a built image), even if it has already been pulled

enum: Always IfNotPresent


description: Size of /dev/shm (shared memory for IPC) for the container


key: labels

description: Labels to apply to the container


key: tasks

description: Definitions for each of your tasks, the actions you launch through Batect


key: task

description: Definition of a single task

required: dependencies run


key: description

description: Description shown when running `batect --list-tasks`


key: group

description: Name used to group tasks when running `batect --list-tasks`


description: List of other containers that should be started and healthy before starting the task container given in `run`


key: prerequisites

description: List of other tasks that should be run before running this task


key: customise

description: Customisations for dependency containers run as part of this task


key: taskRunOptions

description: Specifies what to do when this task starts


key: container

description: Container to run for this task


description: Command to run for this task


description: Entrypoint to use to run the command for this task


description: List of environment variables to pass to the container, in addition to those defined on the container itself


description: List of port mappings to create for the container, in addition to those defined on the container itself


description: Working directory to start the container in


key: id

description: ID used to refer to agent from Dockerfile


key: paths

description: Paths to keys or SSH agent sockets to expose to image build process


description: Name of the environment variable to expose as a secret


key: path

description: Path to the file to expose as a secret


key: local

description: Port on the host machine to map


description: Port inside the container to map


key: protocol

description: Protocol to use (eg. TCP or UDP)


description: Ports on the host machine to map


description: Ports inside the container to map


key: type

description: Type of volume mount


description: Path on the host machine to mount


description: Path inside the container to mount the host path at


key: options

description: Docker volume mount options to use when creating mount

enum: cached delegated consistent default ro


key: name

description: Name of the cache


description: Path inside the container to mount the cache at


description: Path inside the container to mount the tmpfs filesystem at


description: Docker tmpfs mount options to use when creating mount


key: retries

description: The number of times to perform the health check before considering the container unhealthy


key: interval

description: The interval between runs of the health check. Accepts values such as `2s` (two seconds) or `1m` (one minute).


description: The time to wait before failing health checks count against the retry count. The health check is still run during this period, and if the check succeeds, the container is immediately considered healthy. Accepts values such as `2s` (two seconds) or `1m` (one minute).


key: timeout

description: The time to wait before timing out a single health check command invocation. Accepts values such as `2s` (two seconds) or `1m` (one minute).


key: command

description: The command to run to check the health of the container. If this command exits with code 0, the container is considered healthy.


key: enabled

description: Set to `true` to enable 'run as current user' mode


description: Directory to use as home directory for user inside container


description: Command to execute


description: Working directory to start the command in (defaults to container working directory if not set)


key: configVariablesList

description: Definitions for each of the config variables used to configure your tasks and containers


key: configVariable

description: Definition of a single config variable


key: description

description: Human-readable description of the purpose of the variable


key: default

description: Default value of the variable if one is not provided elsewhere


key: includesList

description: List of configuration files to include in this project


key: include

description: Path (relative to this file) to the file to include


description: The type of include


key: path

description: Path (relative to this file) of the file to include


key: repo

description: Git repository containing the file to include


key: ref

description: Git reference (commit, tag or branch) containing the file to include


description: Path (relative to the root of the repository) of the file to include (defaults to batect-bundle.yml if not set)


key: msg

description: The message to display when the API is used.


key: Convention

description: Use Google-style docstrings.


description: Use NumPy-style docstrings.


description: Use PEP257-style docstrings.


key: allow-star-arg-any

description: Whether to suppress `ANN401` for dynamically typed `*args` and `**kwargs` arguments.


key: ignore-fully-untyped

description: Whether to suppress `ANN*` rules for any declaration that hasn't been typed at all. This makes it easier to gradually add types to a codebase.


key: mypy-init-return

description: Whether to allow the omission of a return type hint for `__init__` if at least one argument is annotated.


key: suppress-dummy-args

description: Whether to suppress `ANN000`-level violations for arguments matching the "dummy" variable regex (like `_`).


key: suppress-none-returning

description:
Whether to suppress `ANN200`-level violations for functions that meet either of the following criteria:

- Contain no `return` statement. - Explicit `return` statement(s) all return `None` (explicitly or implicitly).


key: check-typed-exception

description: Whether to disallow `try`-`except`-`pass` (`S110`) for specific exception types. By default, `try`-`except`-`pass` is only disallowed for `Exception` and `BaseException`.


key: hardcoded-tmp-directory

description: A list of directories to consider temporary.


key: hardcoded-tmp-directory-extend

description: A list of directories to consider temporary, in addition to those specified by `hardcoded-tmp-directory`.


key: extend-immutable-calls

description: Additional callable functions to consider "immutable" when evaluating, e.g., the `no-mutable-default-argument` rule (`B006`) or `no-function-call-in-dataclass-defaults` rule (`RUF009`).


key: builtins-ignorelist

description: Ignore list of builtins.


key: allow-dict-calls-with-keyword-arguments

description: Allow `dict` calls that make use of keyword arguments (e.g., `dict(a=1, b=2)`).


key: author

description: Author to enforce within the copyright notice. If provided, the author must be present immediately following the copyright notice.


key: min-file-size

description: A minimum file size (in bytes) required for a copyright notice to be enforced. By default, all files are validated.

format: uint


key: notice-rgx

description:
The regular expression used to match the copyright notice, compiled with the [`regex`](https://docs.rs/regex/latest/regex/) crate.

Defaults to `(?i)Copyright\s+(\(C\)\s+)?\d{4}(-\d{4})*`, which matches the following: - `Copyright 2023` - `Copyright (C) 2023` - `Copyright 2021-2023` - `Copyright (C) 2021-2023`


key: max-string-length

description: Maximum string length for string literals in exception messages.


key: extend-function-names

description: Additional function names to consider as internationalization calls, in addition to those included in `function-names`.


key: function-names

description: The function names to consider as internationalization calls.


key: allow-multiline

description:
Whether to allow implicit string concatenations for multiline strings. By default, implicit concatenations of multiline strings are allowed (but continuation lines, delimited with a backslash, are prohibited).

Note that setting `allow-multiline = false` should typically be coupled with disabling `explicit-string-concatenation` (`ISC003`). Otherwise, both explicit and implicit multiline string concatenations will be seen as violations.


key: aliases

description: The conventional aliases for imports. These aliases can be extended by the `extend_aliases` option.


key: banned-aliases

description: A mapping from module to its banned import aliases.


key: banned-from

description: A list of modules that are allowed to be imported from


key: extend-aliases

description: A mapping from module to conventional import alias. These aliases will be added to the `aliases` mapping.


key: fixture-parentheses

description: Boolean flag specifying whether `@pytest.fixture()` without parameters should have parentheses. If the option is set to `true` (the default), `@pytest.fixture()` is valid and `@pytest.fixture` is invalid. If set to `false`, `@pytest.fixture` is valid and `@pytest.fixture()` is invalid.


key: mark-parentheses

description: Boolean flag specifying whether `@pytest.mark.foo()` without parameters should have parentheses. If the option is set to `true` (the default), `@pytest.mark.foo()` is valid and `@pytest.mark.foo` is invalid. If set to `false`, `@pytest.fixture` is valid and `@pytest.mark.foo()` is invalid.


key: parametrize-names-type

description:
Expected type for multiple argument names in `@pytest.mark.parametrize`. The following values are supported:

- `csv` — a comma-separated list, e.g. `@pytest.mark.parametrize('name1,name2', ...)` - `tuple` (default) — e.g. `@pytest.mark.parametrize(('name1', 'name2'), ...)` - `list` — e.g. `@pytest.mark.parametrize(['name1', 'name2'], ...)`


key: parametrize-values-row-type

description:
Expected type for each row of values in `@pytest.mark.parametrize` in case of multiple parameters. The following values are supported:

- `tuple` (default) — e.g. `@pytest.mark.parametrize(('name1', 'name2'), [(1, 2), (3, 4)])` - `list` — e.g. `@pytest.mark.parametrize(('name1', 'name2'), [[1, 2], [3, 4]])`


key: parametrize-values-type

description:
Expected type for the list of values rows in `@pytest.mark.parametrize`. The following values are supported:

- `tuple` — e.g. `@pytest.mark.parametrize('name', (1, 2, 3))` - `list` (default) — e.g. `@pytest.mark.parametrize('name', [1, 2, 3])`


key: raises-extend-require-match-for

description: List of additional exception names that require a match= parameter in a `pytest.raises()` call. This extends the default list of exceptions that require a match= parameter. This option is useful if you want to extend the default list of exceptions that require a match= parameter without having to specify the entire list. Note that this option does not remove any exceptions from the default list.


key: raises-require-match-for

description: List of exception names that require a match= parameter in a `pytest.raises()` call.


key: avoid-escape

description: Whether to avoid using single quotes if a string contains single quotes, or vice-versa with double quotes, as per [PEP 8](https://peps.python.org/pep-0008/#string-quotes). This minimizes the need to escape quotation marks within strings.


key: docstring-quotes

description: Quote style to prefer for docstrings (either "single" or "double").


key: inline-quotes

description: Quote style to prefer for inline strings (either "single" or "double").


key: multiline-quotes

description: Quote style to prefer for multiline strings (either "single" or "double").


key: ignore-names

description: A list of names to ignore when considering `flake8-self` violations.


key: ban-relative-imports

description: Whether to ban all relative imports (`"all"`), or only those imports that extend into the parent module or beyond (`"parents"`).


key: banned-api

description: Specific modules or module members that may not be imported or accessed. Note that this rule is only meant to flag accidental uses, and can be circumvented via `eval` or `importlib`.


key: exempt-modules

description: Exempt certain modules from needing to be moved into type-checking blocks.


key: runtime-evaluated-base-classes

description: Exempt classes that list any of the enumerated classes as a base class from needing to be moved into type-checking blocks.


key: runtime-evaluated-decorators

description: Exempt classes decorated with any of the enumerated decorators from needing to be moved into type-checking blocks.


key: strict

description: Enforce TC001, TC002, and TC003 rules even when valid runtime imports are present for the same module. See flake8-type-checking's [strict](https://github.com/snok/flake8-type-checking#strict) option.


key: ignore-variadic-names

description: Whether to allow unused variadic arguments, like `*args` and `**kwargs`.


key: classes

description: An override list of tokens to always recognize as a Class for `order-by-type` regardless of casing.


key: combine-as-imports

description: Combines as imports on the same line. See isort's [`combine-as-imports`](https://pycqa.github.io/isort/docs/configuration/options.html#combine-as-imports) option.


key: constants

description: An override list of tokens to always recognize as a CONSTANT for `order-by-type` regardless of casing.


key: extra-standard-library

description: A list of modules to consider standard-library, in addition to those known to Ruff in advance.


key: force-single-line

description: Forces all from imports to appear on their own line.


key: force-sort-within-sections

description: Don't sort straight-style imports (like `import sys`) before from-style imports (like `from itertools import groupby`). Instead, sort the imports by module, independent of import style.


key: force-to-top

description: Force specific imports to the top of their appropriate section.


key: force-wrap-aliases

description:
Force `import from` statements with multiple members and at least one alias (e.g., `import A as B`) to wrap such that every line contains exactly one member. For example, this formatting would be retained, rather than condensing to a single line:

```python from .utils import ( test_directory as test_directory, test_id as test_id ) ```

Note that this setting is only effective when combined with `combine-as-imports = true`. When `combine-as-imports` isn't enabled, every aliased `import from` will be given its own line, in which case, wrapping is not necessary.


key: forced-separate

description: A list of modules to separate into auxiliary block(s) of imports, in the order specified.


key: known-first-party

description: A list of modules to consider first-party, regardless of whether they can be identified as such via introspection of the local filesystem.


key: known-local-folder

description: A list of modules to consider being a local folder. Generally, this is reserved for relative imports (`from . import module`).


key: known-third-party

description: A list of modules to consider third-party, regardless of whether they can be identified as such via introspection of the local filesystem.


key: lines-after-imports

description: The number of blank lines to place after imports. Use `-1` for automatic determination.

format: int


key: lines-between-types

description: The number of lines to place between "direct" and `import from` imports.


key: no-lines-before

description: A list of sections that should _not_ be delineated from the previous section via empty lines.


key: order-by-type

description: Order imports by type, which is determined by case, in addition to alphabetically.


key: relative-imports-order

description:
Whether to place "closer" imports (fewer `.` characters, most local) before "further" imports (more `.` characters, least local), or vice versa.

The default ("furthest-to-closest") is equivalent to isort's `reverse-relative` default (`reverse-relative = false`); setting this to "closest-to-furthest" is equivalent to isort's `reverse-relative = true`.


key: required-imports

description: Add the specified import line to all files.


key: section-order

description: Override in which order the sections should be output. Can be used to move custom sections.


key: sections

description: A list of mappings from section names to modules. By default custom sections are output last, but this can be overridden with `section-order`.


key: single-line-exclusions

description: One or more modules to exclude from the single line rule.


key: split-on-trailing-comma

description:
If a comma is placed after the last member in a multi-line import, then the imports will never be folded into one line.

See isort's [`split-on-trailing-comma`](https://pycqa.github.io/isort/docs/configuration/options.html#split-on-trailing-comma) option.


key: variables

description: An override list of tokens to always recognize as a var for `order-by-type` regardless of casing.


key: LineLength

description: The length of a line of text that is considered too long.


key: max-complexity

description: The maximum McCabe complexity to allow before triggering `C901` errors.


key: classmethod-decorators

description:
A list of decorators that, when applied to a method, indicate that the method should be treated as a class method (in addition to the builtin `@classmethod`).

For example, Ruff will expect that any method decorated by a decorator in this list takes a `cls` argument as its first argument.


key: ignore-names

description: A list of names (or patterns) to ignore when considering `pep8-naming` violations.


key: staticmethod-decorators

description:
A list of decorators that, when applied to a method, indicate that the method should be treated as a static method (in addition to the builtin `@staticmethod`).

For example, Ruff will expect that any method decorated by a decorator in this list has no `self` or `cls` argument.


key: keep-runtime-typing

description:
Whether to avoid PEP 585 (`List[int]` -> `list[int]`) and PEP 604 (`Union[str, int]` -> `str | int`) rewrites even if a file imports `from __future__ import annotations`.

This setting is only applicable when the target Python version is below 3.9 and 3.10 respectively, and is most commonly used when working with libraries like Pydantic and FastAPI, which rely on the ability to parse type annotations at runtime. The use of `from __future__ import annotations` causes Python to treat the type annotations as strings, which typically allows for the use of language features that appear in later Python versions but are not yet supported by the current version (e.g., `str | int`). However, libraries that rely on runtime type annotations will break if the annotations are incompatible with the current Python version.

For example, while the following is valid Python 3.8 code due to the presence of `from __future__ import annotations`, the use of `str| int` prior to Python 3.10 will cause Pydantic to raise a `TypeError` at runtime:

```python from __future__ import annotations

import pydantic

class Foo(pydantic.BaseModel): bar: str | int ```


key: ignore-overlong-task-comments

description: Whether line-length violations (`E501`) should be triggered for comments starting with `task-tags` (by default: \["TODO", "FIXME", and "XXX"\]).


key: max-doc-length

description: The maximum line length to allow for line-length violations within documentation (`W505`), including standalone comments.


key: convention

description: Whether to use Google-style or NumPy-style conventions or the PEP257 defaults when analyzing docstring sections.


key: ignore-decorators

description: Ignore docstrings for functions or methods decorated with the specified fully-qualified decorators.


key: property-decorators

description:
A list of decorators that, when applied to a method, indicate that the method should be treated as a property (in addition to the builtin `@property` and standard-library `@functools.cached_property`).

For example, Ruff will expect that any method decorated by a decorator in this list can use a non-imperative summary line.


key: extend-generics

description: Additional functions or classes to consider generic, such that any subscripts should be treated as type annotation (e.g., `ForeignKey` in `django.db.models.ForeignKey["User"]`.


key: allow-magic-value-types

description: Constant types to ignore when used as "magic values" (see: `PLR2004`).


key: max-args

description: Maximum number of arguments allowed for a function or method definition (see: `PLR0913`).


key: max-branches

description: Maximum number of branches allowed for a function or method body (see: `PLR0912`).


key: max-returns

description: Maximum number of return statements allowed for a function or method body (see `PLR0911`)


key: max-statements

description: Maximum number of statements allowed for a function or method body (see: `PLR0915`).


key: Quote

description: Use double quotes.


description: Use single quotes.


key: RelativeImportsOrder

description: Place "closer" imports (fewer `.` characters, most local) before "further" imports (more `.` characters, least local).


description: Place "further" imports (more `.` characters, least local) imports before "closer" imports (fewer `.` characters, most local).


key: Strictness

description: Ban imports that extend into the parent module or beyond.


description: Ban all relative imports.


key: TabSize

description: The size of a tab.


key: allowed-confusables

description: A list of allowed "confusable" Unicode characters to ignore when enforcing `RUF001`, `RUF002`, and `RUF003`.


key: builtins

description: A list of builtins to treat as defined references, in addition to the system builtins.


key: cache-dir

description:
A path to the cache directory.

By default, Ruff stores cache results in a `.ruff_cache` directory in the current project root.

However, Ruff will also respect the `RUFF_CACHE_DIR` environment variable, which takes precedence over that default.

This setting will override even the `RUFF_CACHE_DIR` environment variable, if set.


key: dummy-variable-rgx

description: A regular expression used to identify "dummy" variables, or those which should be ignored when enforcing (e.g.) unused-variable rules. The default expression matches `_`, `__`, and `_var`, but not `_var_`.


key: exclude

description:
A list of file patterns to exclude from linting.

Exclusions are based on globs, and can be either:

- Single-path patterns, like `.mypy_cache` (to exclude any directory named `.mypy_cache` in the tree), `foo.py` (to exclude any file named `foo.py`), or `foo_*.py` (to exclude any file matching `foo_*.py` ). - Relative patterns, like `directory/foo.py` (to exclude that specific file) or `directory/*.py` (to exclude any Python files in `directory`). Note that these paths are relative to the project root (e.g., the directory containing your `pyproject.toml`).

For more information on the glob syntax, refer to the [`globset` documentation](https://docs.rs/globset/latest/globset/#syntax).

Note that you'll typically want to use [`extend-exclude`](#extend-exclude) to modify the excluded paths.


key: extend

description:
A path to a local `pyproject.toml` file to merge into this configuration. User home directory and environment variables will be expanded.

To resolve the current `pyproject.toml` file, Ruff will first resolve this base configuration file, then merge in any properties defined in the current configuration file.


key: extend-exclude

description:
A list of file patterns to omit from linting, in addition to those specified by `exclude`.

Exclusions are based on globs, and can be either:

- Single-path patterns, like `.mypy_cache` (to exclude any directory named `.mypy_cache` in the tree), `foo.py` (to exclude any file named `foo.py`), or `foo_*.py` (to exclude any file matching `foo_*.py` ). - Relative patterns, like `directory/foo.py` (to exclude that specific file) or `directory/*.py` (to exclude any Python files in `directory`). Note that these paths are relative to the project root (e.g., the directory containing your `pyproject.toml`).

For more information on the glob syntax, refer to the [`globset` documentation](https://docs.rs/globset/latest/globset/#syntax).


key: extend-fixable

description: A list of rule codes or prefixes to consider autofixable, in addition to those specified by `fixable`.


key: extend-include

description:
A list of file patterns to include when linting, in addition to those specified by `include`.

Inclusion are based on globs, and should be single-path patterns, like `*.pyw`, to include any file with the `.pyw` extension.

For more information on the glob syntax, refer to the [`globset` documentation](https://docs.rs/globset/latest/globset/#syntax).


key: extend-per-file-ignores

description: A list of mappings from file pattern to rule codes or prefixes to exclude, in addition to any rules excluded by `per-file-ignores`.


key: extend-select

description: A list of rule codes or prefixes to enable, in addition to those specified by `select`.


key: external

description: A list of rule codes that are unsupported by Ruff, but should be preserved when (e.g.) validating `# noqa` directives. Useful for retaining `# noqa` directives that cover plugins not yet implemented by Ruff.


key: fix

description: Enable autofix behavior by-default when running `ruff` (overridden by the `--fix` and `--no-fix` command-line flags).


key: fix-only

description: Like `fix`, but disables reporting on leftover violation. Implies `fix`.


key: fixable

description: A list of rule codes or prefixes to consider autofixable. By default, all rules are considered autofixable.


Options for the `flake8-annotations` plugin.


Options for the `flake8-bandit` plugin.


Options for the `flake8-bugbear` plugin.


Options for the `flake8-builtins` plugin.


Options for the `flake8-comprehensions` plugin.


Options for the `copyright` plugin.


Options for the `flake8-errmsg` plugin.


Options for the `flake8-gettext` plugin.


Options for the `flake8-implicit-str-concat` plugin.


Options for the `flake8-import-conventions` plugin.


Options for the `flake8-pytest-style` plugin.


Options for the `flake8-quotes` plugin.


Options for the `flake8_self` plugin.


Options for the `flake8-tidy-imports` plugin.


Options for the `flake8-type-checking` plugin.


Options for the `flake8-unused-arguments` plugin.


key: force-exclude

description:
Whether to enforce `exclude` and `extend-exclude` patterns, even for paths that are passed to Ruff explicitly. Typically, Ruff will lint any paths passed in directly, even if they would typically be excluded. Setting `force-exclude = true` will cause Ruff to respect these exclusions unequivocally.

This is useful for [`pre-commit`](https://pre-commit.com/), which explicitly passes all changed files to the [`ruff-pre-commit`](https://github.com/astral-sh/ruff-pre-commit) plugin, regardless of whether they're marked as excluded by Ruff's own settings.


key: format

description: The style in which violation messages should be formatted: `"text"` (default), `"grouped"` (group messages by file), `"json"` (machine-readable), `"junit"` (machine-readable XML), `"github"` (GitHub Actions annotations), `"gitlab"` (GitLab CI code quality report), `"pylint"` (Pylint text format) or `"azure"` (Azure Pipeline logging commands).


key: ignore

description:
A list of rule codes or prefixes to ignore. Prefixes can specify exact rules (like `F841`), entire categories (like `F`), or anything in between.

When breaking ties between enabled and disabled rules (via `select` and `ignore`, respectively), more specific prefixes override less specific prefixes.


key: ignore-init-module-imports

description: Avoid automatically removing unused imports in `__init__.py` files. Such imports will still be flagged, but with a dedicated message suggesting that the import is either added to the module's `__all__` symbol, or re-exported with a redundant alias (e.g., `import os as os`).


key: include

description:
A list of file patterns to include when linting.

Inclusion are based on globs, and should be single-path patterns, like `*.pyw`, to include any file with the `.pyw` extension. `pyproject.toml` is included here not for configuration but because we lint whether e.g. the `[project]` matches the schema.

For more information on the glob syntax, refer to the [`globset` documentation](https://docs.rs/globset/latest/globset/#syntax).


key: isort

description: Options for the `isort` plugin.


key: line-length

description: The line length to use when enforcing long-lines violations (like `E501`).


key: mccabe

description: Options for the `mccabe` plugin.


key: namespace-packages

description: Mark the specified directories as namespace packages. For the purpose of module resolution, Ruff will treat those directories as if they contained an `__init__.py` file.


Options for the `pep8-naming` plugin.


key: per-file-ignores

description: A list of mappings from file pattern to rule codes or prefixes to exclude, when considering any matching files.


key: pycodestyle

description: Options for the `pycodestyle` plugin.


key: pydocstyle

description: Options for the `pydocstyle` plugin.


key: pyflakes

description: Options for the `pyflakes` plugin.


key: pylint

description: Options for the `pylint` plugin.


key: pyupgrade

description: Options for the `pyupgrade` plugin.


key: required-version

description: Require a specific version of Ruff to be running (useful for unifying results across many environments, e.g., with a `pyproject.toml` file).


key: respect-gitignore

description: Whether to automatically exclude files that are ignored by `.ignore`, `.gitignore`, `.git/info/exclude`, and global `gitignore` files. Enabled by default.


key: select

description:
A list of rule codes or prefixes to enable. Prefixes can specify exact rules (like `F841`), entire categories (like `F`), or anything in between.

When breaking ties between enabled and disabled rules (via `select` and `ignore`, respectively), more specific prefixes override less specific prefixes.


key: show-fixes

description: Whether to show an enumeration of all autofixed lint violations (overridden by the `--show-fixes` command-line flag).


key: show-source

description: Whether to show source code snippets when reporting lint violations (overridden by the `--show-source` command-line flag).


key: src

description:
The source code paths to consider, e.g., when resolving first- vs. third-party imports.

As an example: given a Python package structure like:

```text my_package/ pyproject.toml src/ my_package/ __init__.py foo.py bar.py ```

The `src` directory should be included in the `src` option (e.g., `src = ["src"]`), such that when resolving imports, `my_package.foo` is considered a first-party import.

When omitted, the `src` directory will typically default to the directory containing the nearest `pyproject.toml`, `ruff.toml`, or `.ruff.toml` file (the "project root"), unless a configuration file is explicitly provided (e.g., via the `--config` command-line flag).

This field supports globs. For example, if you have a series of Python packages in a `python_modules` directory, `src = ["python_modules/*"]` would expand to incorporate all of the packages in that directory. User home directory and environment variables will also be expanded.


key: tab-size

description: The tabulation size to calculate line length.


key: target-version

description:
The minimum Python version to target, e.g., when considering automatic code upgrades, like rewriting type annotations.

If omitted, and Ruff is configured via a `pyproject.toml` file, the target version will be inferred from its `project.requires-python` field (e.g., `requires-python = ">=3.8"`). If Ruff is configured via `ruff.toml` or `.ruff.toml`, no such inference will be performed.


key: task-tags

description:
A list of task tags to recognize (e.g., "TODO", "FIXME", "XXX").

Comments starting with these tags will be ignored by commented-out code detection (`ERA`), and skipped by line-length rules (`E501`) if `ignore-overlong-task-comments` is set to `true`.


key: typing-modules

description:
A list of modules whose imports should be treated equivalently to members of the `typing` module.

This is useful for ensuring proper type annotation inference for projects that re-export `typing` and `typing_extensions` members from a compatibility module. If omitted, any members imported from modules apart from `typing` and `typing_extensions` will be treated as ordinary Python objects.


key: unfixable

description: A list of rule codes or prefixes to consider non-autofix-able.


description: Ray autoscaler schema

default: ubuntu


key: items

description: shell command


description: A unique identifier for the head node and workers of this cluster.


description: The maximum number of workers nodes to launch in addition to the head node. This takes precedence over min_workers.


description: The autoscaler will scale up the cluster faster with higher upscaling speed. E.g., if the task requires adding more nodes then autoscaler will gradually scale up the cluster in chunks of upscaling_speed*currently_running_nodes. This number should be > 0.


description: If a node is idle for this many minutes, it will be removed.


key: provider

description: Cloud-provider specific configuration.


key: type

description: e.g. aws, azure, gcp,...


key: region

description: e.g. us-east-1


key: module

description: module, if using external node provider


description: gcp project id, if using gcp


description: local cluster head node


description: don't require public ips


key: namespace

description: k8s namespace, if using k8s


key: location

description: Azure location


description: Azure resource group


key: tags

description: Azure user-defined tags


description: Azure subscription id


description: User-defined managed identity (generated by config)


description: User-defined managed identity principal id (generated by config)


description: Network subnet id


description: k8s autoscaler permissions, if using k8s


description: Whether to try to reuse previously stopped nodes instead of launching nodes. This will also cause the autoscaler to stop nodes instead of terminating them. Only implemented for AWS.


description: GCP availability zone


GCP globally unique project id


description: AWS security group


key: GroupName

description: Security group name


key: IpPermissions

description: Security group in bound rules


description: Disables node updaters if set to True. Default is False. (For Kubernetes operator usage.)


description: Credentials for authenticating with the GCP client


description: Credentials type: either temporary OAuth 2.0 token or permanent service account credentials blob.


key: credentials

description: Oauth token or JSON string constituting service account credentials


Tag to be added to cloudwatch agent pre-installed AMI name.


key: config

description: Path to Unified CloudWatch Agent config file. See https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Agent-Configuration-File-Details.html for additional details.


Max allowed Unified CloudWatch Agent installation attempts on any host.


Seconds to wait between each Unified CloudWatch Agent installation attempt.


key: name

description: User defined CloudWatch Dashboard name.


description: Path to CloudWatch Dashboard config file. See https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/CloudWatch-Dashboard-Body-Structure.html for additional details.


description: Path to CloudWatch Alarm config file. See https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_PutMetricAlarm.html for additional details.


key: auth

description: How Ray will authenticate with newly launched nodes.


description: A value for ProxyCommand ssh option, for connecting through proxies. Example: nc -x proxy.example.com:1234 %h %p


key: docker

description: Docker configuration. If this is specified, all setup and start commands will be executed in the container.


key: image

description: the docker image name


description: run `docker pull` first


description: shared options for starting head/worker docker


description: image for head node, takes precedence over 'image' if specified


description: head specific run options, appended to run_options


description: analogous to head_image


description: analogous to head_run_options


description: disable Ray from automatically using the NVIDIA runtime if available


description: disable Ray from automatically detecting /dev/shm size for the container


description: Use 'podman' command in place of 'docker'


description: If using multiple node types, specifies the head node type.


description: Map of remote paths to local paths, e.g. {"/tmp/data": "/my/local/data"}


description: List of paths on the head node which should sync to the worker nodes, e.g. ["/some/data/somehwere"]


description: If enabled, file mounts will sync continously between the head node and the worker nodes. The nodes will not re-run setup commands if only the contents of the file mounts folders change.


description: File pattern to not sync up or down when using the rsync command. Matches the format of rsync's --exclude param.


description: Pattern files to lookup patterns to exclude when using rsync up or rsync down. This file is checked for recursively in all directories. For example, if .gitignore is provided here, the behavior will match git's .gitignore behavior.


key: metadata

description: Metadata field that can be used to store user-defined data in the cluster config. Ray does not interpret these fields.


List of commands that will be run before `setup_commands`. If docker is enabled, these commands will run outside the container and before docker is setup.


List of common shell commands to run to setup nodes.


Commands that will be run on the head node after common setup.


Commands that will be run on worker nodes after common setup.


Command to start ray on the head node. You shouldn't need to modify this.


Command to start ray on worker nodes. You shouldn't need to modify this.


Whether to avoid restarting the cluster during updates. This field is controlled by the ray --no-restart flag and cannot be set by the user.


description: A list of node types for multi-node-type autoscaling.


description: Provider-specific config for the node, e.g. instance type.


List of common shell commands to run to setup nodes. This node specfic list will override the global setup_commands and worker_setup_commands.


description: Configuration of Worker nodes.


description: run `docker pull` first


description: analogous to head_image


description: analogous to head_run_options, merged with the global docker run_options.


description: Crate name used for display purposes, without affecting semantics.


description: Path to the root module of the crate.


key: edition

description: Edition of the crate.


key: deps

description: Crate dependencies.


key: version

description: The crate's version


description: Whether this crate should be treated as a member of the current "workspace".


key: source

description: (Super)set of `.rs` files comprising this crate.


key: cfg

description: The set of cfgs activated for a given crate.


key: target

description: Target triple for this crate.


key: env

description: Environment variables, used for the `env!` macro


description: Whether the crate is a proc-macro crate.


description: For proc-macro crates, path to compiled proc-macro (.so file).


key: repository

description: URL to the source repository of the crate.


key: crate

description: Index of a crate in the `crates` array.


description: Name as should appear in the (implicit) `extern crate name` declaration.


key: sysroot

description: Path to sysroot.


description: Path to the directory with source code of sysroot crates.


key: crates

description: The set of crates comprising the current project.


description: Descriptor for projects. Contains all the information contained within a .uproject file.

enum: Unknown Debug DebugGame Development Shipping Test

enum: Unknown Game Server Client Editor Program

enum: EarliestPossible PostConfigInit PostSplashScreen PreEarlyLoadingScreen PreLoadingScreen PreDefault Default PostDefault PostEngineInit None Max

enum: Runtime RuntimeNoCommandlet RuntimeAndProgram CookedOnly UncookedOnly Developer DeveloperTool Editor EditorNoCommandlet EditorAndProgram Program ServerOnly ClientOnly ClientOnlyNoCommandlet Max

required: Enabled Name

required: EngineAssociation FileVersion


key: BuildConfiguration

description: Available build configurations. Mirorred from UnrealTargetConfiguration.


key: BuildTargetType

description: Enumerates build target types.


key: ModuleDescriptor

description: Description of a loadable module.


key: AdditionalDependencies

description: List of additional dependencies for building this module.


key: HasExplicitPlatforms

description: When true, an empty PlatformAllowList is interpeted as 'no platforms' with the expectation that explict platforms will be added in plugin extensions.


key: LoadingPhase

description: When should the module be loaded during the startup sequence? This is sort of an advanced setting.


key: Name

description: Name of this module.


key: PlatformAllowList

description: List of allowed platforms.


key: PlatformDenyList

description: List of disallowed platforms.


key: ProgramAllowList

description: List of allowed programs.


key: ProgramDenyList

description: List of disallowed programs.


key: TargetAllowList

description: List of allowed targets.


key: TargetConfigurationAllowList

description: List of allowed target configurations.


key: TargetConfigurationDenyList

description: List of disallowed target configurations.


key: TargetDenyList

description: List of disallowed targets.


key: Type

description: Usage type of module.


key: PluginReferenceDescriptor

description: Descriptor for a plugin reference.


key: Enabled

description: Whether it should be enabled by default.


description: When true, empty SupportedTargetPlatforms and PlatformAllowList are interpreted as 'no platforms' with the expectation that explicit platforms will be added in plugin platform extensions.


key: Optional

description: Whether this plugin is optional, and the game should silently ignore it not being present.


key: Description

description: Description of the plugin for users that do not have it installed.


key: MarketplaceURL

description: URL for this plugin on the marketplace, if the user doesn't have it installed.


description: Name of the plugin.


key: DisableEnginePluginsByDefault

description: Indicates that enabled by default engine plugins should not be enabled unless explicitly enabled by the project or target files.


key: IsEnterpriseProject

description: Indicates if this project is an Enterprise project.


key: Category

description: Category to show under the project browser.


description: Description to show in the project browser.


key: EngineAssociation

description: The engine to open this project with. Denotes by <major>.<minor> convention e.g. 4.20, 5.0 or source engine hash.


key: EpicSampleNameHash

description: A hash that is used to determine if the project was forked from a sample.


key: FileVersion

description: Descriptor version number.


key: Modules

description: List of all modules associated with this project.


key: Plugins

description: List of plugins for this project (may be enabled/disabled).


key: PostBuildSteps

description: Custom steps to execute after building targets in this project.


key: PreBuildSteps

description: Custom steps to execute before building targets in this project.


key: TargetPlatforms

description: Array of platforms that this project is targeting.


description: plagiarize-me.yaml configuration schema

required: to names

required: type path

required: condition pattern

default: master

required: type options

type: string integer boolean

required: name replace

type: string boolean number

type: string boolean number null


key: to

description: The path to move the directory to


key: items

description: The directories to move


key: mergeJson

description: Merge json file with jq command line tool pattern matching

type: object


key: type

description: Merge type

type: string


key: path

description: Path to file to merge


key: replace

description: JQ pattern of property to replace


key: create

description: JQ pattern of property to create if the property does not exist in target project file


key: replaceIf

description: A set of properties to replace if the condition evaluates to truthy


description: Configuration for property to replace if condition evaluates to truthy


key: condition

description: The condition to evaluate for truthiness. If truthy will replace property matched by pattern


key: pattern

description: JQ pattern of property to replace


key: set

description: Set the value of these items to the value. So `'.license':MIT` would set the `license` property of the json file to 'MIT'


key: skip

description: A list of items to not create, copy, replace, or remove in target file


key: mergeYaml

description: Merge yaml file with yq command line tool pattern matching


description: YQ pattern of property to replace


description: YQ pattern of property to create if the property does not exist in target project file


description: YQ pattern of property to replace


description: Set the value of these items to the value. So `'license':MIT` would set the `license` property of the yaml file to 'MIT'


key: mergeGit

description: Merge file using git merge (use with varied reliability)


description: List of Environment variable names to create in target project if they are not already created


description: The Environment variable name


key: repo

description: Git repo of where this plagiarizable project is hosted


key: url

description: The git repo url of this project


key: checkout

description: The default branch that downstream projects should checkout when plagiarizing this project


key: move

description: Files to move in target project from their previous locations


key: directories

description: Directories to move from the target repo to the target repo. Useful for refactoring project structures


key: files

description: Files to move from the target repo to the target repo. Useful for refactoring


key: run

description: Shell commands to run after plagiarize files are done being copied and updated

type: boolean


key: command

description: The shell command to run


key: parallel

description: Whether or not to run this command synchronously or in parallel to other commands where `parallel: true`


key: when

description: Condition type


description: Run this command only if configured file does not exist in target project


key: type

description: Condition type


description: Always run this command


key: replace

description: Configuration for strings, files, and file paths to replace in target file


key: strings

description: Strings to find in target project and be replaced with plagiarized project's values


key: vars

description: Variables available to be used for finding and replacing by variable name. For example `$var_name: hello` would replace string '$var_name' with 'hello' in target project


description: Relative path to target files that will be completely overwritten by source files in the same path


description: Files to copy from plagiarized project if they do not exist in the target project


key: andClean

description: Files to remove commented sections from. Eg code between `// plagiarize:start:always:delete` and `// plagiarize:end:always:delete`


key: templates

description: Files that are used the have similarities between instances of that that. .env files for example are similar and could be templated


key: name

description: The name of the template


description: Values to be used as variables within the target project. So `var_name: hello` in the template configuration and `var_name: world` would replace instances of 'hello' found in the source file with with 'world' found in the target file


key: values

description: Values to be used as variables within the target project. So `var_name: hello` would replace instances of '$var_name' with 'hello' in the target file


description: Values to be used as variables within the plagiarize-me.yaml file only. So `var_name: hello` would replace '$var_name' with 'hello' in plagiarize-me.yaml


key: items

description: The path to the file to create if it does not already exist


description: Values to set when iterating through each instance


key: remotes

description: A list of removes to push to (if `push: true`)


description: name of the remote


description: BizTalk Server Application Inventory Schema


key: BizTalkAssemblies

description: Array of BizTalk Reference Assemblies to be deployed.


key: Name

description: Filename of the BizTalk Referenced Assembly.


key: Path

description:
Relative output filepath for the Referenced Assembly.
Example: bins\\bts1.dll


key: BindingsFiles

description: Array of Binding Files used in Deployment.


description: Filename of the Bindings File.


description:
Relative output filepath for the Bindings File.
Example: bindings\\binding1.xml


key: Assemblies

description: Array of Reference Assemblies to be deployed.


description: Filename of the Referenced Assembly.


description:
Relative output filepath for the Unmanaged Referenced Assembly.
Example: bins\\bts1.dll


key: PreProcessingScripts

description: Pre-Processing Scripts used in Deployment.


description: Filename of the Pre Processing Script.


description:
Relative output filepath for the Pre Processing Script.
Example: bins\\Script1.vbs


key: Arguments

description:
Arguments for the Pre Processing Script .
Example: arg1,arg2


key: PostProcessingScripts

description: Post-Processing Scripts used in Deployment.


description: Filename of the Post Processing Script.


description:
Relative output filepath for the Post Processing Script.
Example: Script\\Script1.vbs


description:
Arguments for the Post Processing Script .
Example: arg1,arg2


key: Files

description: File used in Deployment.


description: Name of the File


description:
Relative output filepath for the Files.
Example: File\\File.txt


key: DeploymentSequence

description: Sequence of Binding Files, Reference Assemblies, Pre-Processing and Post-Processing Scripts used in Deployment.


key: concurrency

description: Number of requests a function can serve at once.


key: cors

description:
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


key: cpu

description: Fractional number of CPUs to allocate to a function.


key: enforceAppCheck

description: Determines whether Firebase AppCheck is enforced. Defaults to false.


key: ingressSettings

description: Ingress settings which control where this function can be called from.


key: invoker

description: Invoker to set access control on https functions.


key: labels

description: User labels to set on the function.


key: maxInstances

description: Max number of instances to be running in parallel.


key: memory

description: Amount of memory to allocate to a function.


key: minInstances

description: Min number of actual instances to be running at a given time.


key: omit

description: If true, do not deploy or emulate this function.


key: preserveExternalChanges

description: Controls whether function configuration modified outside of function source is preserved. Defaults to false.


key: region

description: HTTP functions can override global options and can specify multiple regions to deploy to.


key: serviceAccount

description: Specific service account for the function to run as.


key: timeoutSeconds

description:
Timeout for the function in seconds, possible values are 0 to 540.
HTTPS functions can specify a higher timeout.


key: vpcConnector

description: Connect cloud function to specified VPC connector.


key: vpcConnectorEgressSettings

description: Egress settings for VPC connector.


key: namespace

description: Forces a specific namespace for connectors that perform namespace auto-detection (Advanced).


key: collectPeriod

description: Sets the collect period that Hardware Sentry uses to collects metrics from the monitored hosts (Default: 2m).


key: disableAlerts

description: Disables Hardware Sentry's alerts for all the monitored hosts (Default: false).


key: discoveryCycle

description: 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


key: exporter

description: Sets Hardware Sentry's internal Exporter configuration.


key: otlp

description: Overrides Hardware Sentry's internal OTLP Exporter configuration.


key: headers

description: Sets Hardware Sentry's OTLP Exporter headers, such as the `Authorization` header used to authenticate the Exporter with the OTLP gRPC Receiver.


key: trustedCertificatesFile

description: Sets Hardware Sentry's OTLP Exporter trusted certificates file (Default: security/otel.crt).


key: endpoint

description: Configures the OTLP Receiver endpoint (Default: https://localhost:4317).


key: extraLabels

description: 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.


key: extraMetrics

description: Adds additional static metrics to be exposed by Hardware Sentry.


key: hardwareProblemTemplate

description: Overrides the default hardware problem template used to build the alert body for all the monitored hosts.


key: hosts

description: Configures the hosts to monitor.

type: array

required: hostname type

required: hostnames type

default: sudo

default: public

enum: none aes des

default: https

enum: ntlm kerberos

default: http


description: Sets the default collect period that Hardware Sentry uses to collects metrics from the monitored host (Default: 2m).


description: Disables Hardware Sentry's alerts for the monitored host (Default: false).


description: 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.


key: excludedConnectors

description: Sets the Connector(s) that must be excluded from the automatic detection.


description: Adds or overrides the attributes of the monitored host.


description: Overrides the default hardware problem template used to build the alert body for the monitored host.


key: host

description: Configures a new host to be monitored.


key: hostname

description: Configures the hostname of the host to be monitored.


key: id

description: Configures the identifier of the host to be monitored (Optional). By default, the host identifier is the hostname property value.


key: type

description: Configures the type of the host to be monitored.


key: hostGroup

description: Configures several hosts which share the same characteristics.


key: hostnames

description: Configures the hostnames of the hosts to be monitored.


description: Configures the type of the hosts to be monitored.


key: http

description: Configures the HTTP protocol to access the host.


key: https

description: Enables HTTPS to access the host (Default: true).


key: password

description: Sets the password used to establish the connection with the host through the HTTP protocol.


key: port

description: Sets the HTTPS port number used to perform HTTP requests (Default: 443).


key: timeout

description: Sets how long until the HTTP request times out (Default: 120s).


key: username

description: Sets the username used to establish the connection with the host through the HTTP protocol.


key: ipmi

description: Configures the IPMI protocol to access the host.


description: Sets the password used to establish the connection with the host through the IPMI protocol.


description: Sets how long until the IPMI request times out (Default: 120s).


description: Sets the username used to establish the connection with the host through the IPMI protocol.


key: loggerLevel

description: Enables the debug mode of the core engine on the specific host (Default: off).


key: operationTimeout

description: Sets how long until the engine's discovery and collect operations time out.


key: osCommand

description: Configures the OS Command protocol to access the host.


key: sudoCommand

description: Sets the sudo command to be used for the host to be monitored (Default: sudo).


description: Sets how long until the local OS Command times out (Default: 120s).


key: useSudo

description: Sets if sudo needs to be used for the local OS Command (Default: false).


key: useSudoCommands

description: Sets the list of commands for which sudo is required.


key: outputDirectory

description: 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.


key: selectedConnectors

description: Sets the Connector(s) to use to monitor the host. No automatic detection will be performed.


key: sequential

description: Forces all the network calls to be executed in sequential order for the monitored host - NOT RECOMMENDED (Default: false).


key: snmp

description: Configures the SNMP protocol to access the host.


key: community

description: Sets the SNMP Community string to use to perform SNMP v1 queries (Default: public).


description: SNMP v3 only - Sets the password to use for performing the SNMP query.


description: Sets the SNMP port number used to perform SNMP queries (Default: 161).


key: privacy

description: SNMP v3 only - Sets the type of encryption protocol.