HashiConf 2025 Don't miss the live stream of HashiConf Day 2 happening now View live stream
Nomad
Nomad Home

You are viewing documentation for pre-release version v1.11.0 (beta). View latest version.

nomad windows service install command reference

The windows service install command installs the Nomad binary and creates a Windows service.

Usage

nomad windows service install

The windows service install command installs the nomad binary used to run this command, creates a data and configuration directory, writes a basic Nomad configuration file, creates a Windows service to run Nomad, and registers the service with Windows Event Log.

If Nomad has been previously installed using this command, subsequent executions will do the following:

  1. Stop the service if it is running
  2. Install the currently executing nomad binary
  3. Ensure data and configuration directories exist
  4. Write a configuration file if no configuration files are found
  5. Update the service if needed
  6. Update the Event Log configuration if needed.

Options

  • -config-dir <dir>: Directory to hold the Nomad agent configuration. Defaults to "{{.ProgramFiles}}\HashiCorp\nomad\bin"

  • -data-dir <dir>: Directory to hold the Nomad agent state. Defaults to "{{.ProgramData}}\HashiCorp\nomad\data"

  • -install-dir <dir>: Directory to install the Nomad binary. Defaults to "{{.ProgramData}}\HashiCorp\nomad\config"

  • -reinstall: Allow the nomad Windows service to be stopped during install.

General options

  • -address=<addr>: The address of the Nomad server. Overrides the NOMAD_ADDR environment variable if set. Defaults to http://127.0.0.1:4646.

  • -region=<region>: The region of the Nomad server to forward commands to. Overrides the NOMAD_REGION environment variable if set. Defaults to the Agent's local region.

  • -namespace=<namespace>: The target namespace for queries and actions bound to a namespace. Overrides the NOMAD_NAMESPACE environment variable if set. If set to '*', subcommands which support this functionality query all namespaces authorized to user. Defaults to the "default" namespace.

  • -no-color: Disables colored command output. Alternatively, NOMAD_CLI_NO_COLOR may be set. This option takes precedence over -force-color.

  • -force-color: Forces colored command output. This can be used in cases where the usual terminal detection fails. Alternatively, NOMAD_CLI_FORCE_COLOR may be set. This option has no effect if -no-color is also used.

  • -ca-cert=<path>: Path to a PEM encoded CA cert file to use to verify the Nomad server SSL certificate. Overrides the NOMAD_CACERT environment variable if set.

  • -ca-path=<path>: Path to a directory of PEM encoded CA cert files to verify the Nomad server SSL certificate. If both -ca-cert and -ca-path are specified, -ca-cert is used. Overrides the NOMAD_CAPATH environment variable if set.

  • -client-cert=<path>: Path to a PEM encoded client certificate for TLS authentication to the Nomad server. Must also specify -client-key. Overrides the NOMAD_CLIENT_CERT environment variable if set.

  • -client-key=<path>: Path to an unencrypted PEM encoded private key matching the client certificate from -client-cert. Overrides the NOMAD_CLIENT_KEY environment variable if set.

  • -tls-server-name=<value>: The server name to use as the SNI host when connecting via TLS. Overrides the NOMAD_TLS_SERVER_NAME environment variable if set.

  • -tls-skip-verify: Do not verify TLS certificate. This is highly not recommended. Verification will also be skipped if NOMAD_SKIP_VERIFY is set.

  • -token: The SecretID of an ACL token to use to authenticate API requests with. Overrides the NOMAD_TOKEN environment variable if set.