community.general.nomad_job_info (8.5.0) — module

Install collection

Install with ansible-galaxy collection install community.general:==8.5.0

Add to requirements.yml

  collections:
    - name: community.general
      version: 8.5.0

Description

Get info for one Nomad job.

List Nomad jobs.

Requirements

• python-nomad

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Get info for job awx
  community.general.nomad_job_info:
    host: localhost
    name: awx
  register: result

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: List Nomad jobs
  community.general.nomad_job_info:
    host: localhost
  register: result

Inputs

    
host:
    description:
    - FQDN of Nomad server.
    required: true
    type: str

name:
    description:
    - Name of job for Get info.
    - If not specified, lists all jobs.
    type: str

port:
    default: 4646
    description:
    - Port of Nomad server.
    type: int
    version_added: 8.0.0
    version_added_collection: community.general

token:
    description:
    - ACL token for authentication.
    type: str

timeout:
    default: 5
    description:
    - Timeout (in seconds) for the request to Nomad.
    type: int

use_ssl:
    default: true
    description:
    - Use TLS/SSL connection.
    type: bool

namespace:
    description:
    - Namespace for Nomad.
    type: str

client_key:
    description:
    - Path of certificate's private key for TLS/SSL.
    type: path

client_cert:
    description:
    - Path of certificate for TLS/SSL.
    type: path

validate_certs:
    default: true
    description:
    - Enable TLS/SSL certificate validation.
    type: bool

Outputs

result:
  description: List with dictionary contains jobs info
  returned: success
  sample:
  - Affinities: null
    AllAtOnce: false
    Constraints: null
    ConsulToken: ''
    CreateIndex: 13
    Datacenters:
    - dc1
    Dispatched: false
    ID: example
    JobModifyIndex: 13
    Meta: null
    ModifyIndex: 13
    Multiregion: null
    Name: example
    Namespace: default
    NomadTokenID: ''
    ParameterizedJob: null
    ParentID: ''
    Payload: null
    Periodic: null
    Priority: 50
    Region: global
    Spreads: null
    Stable: false
    Status: pending
    StatusDescription: ''
    Stop: false
    SubmitTime: 1602244370615307000
    TaskGroups:
    - Affinities: null
      Constraints: null
      Count: 1
      EphemeralDisk:
        Migrate: false
        SizeMB: 300
        Sticky: false
      Meta: null
      Migrate:
        HealthCheck: checks
        HealthyDeadline: 300000000000
        MaxParallel: 1
        MinHealthyTime: 10000000000
      Name: cache
      Networks: null
      ReschedulePolicy:
        Attempts: 0
        Delay: 30000000000
        DelayFunction: exponential
        Interval: 0
        MaxDelay: 3600000000000
        Unlimited: true
      RestartPolicy:
        Attempts: 3
        Delay: 15000000000
        Interval: 1800000000000
        Mode: fail
      Scaling: null
      Services: null
      ShutdownDelay: null
      Spreads: null
      StopAfterClientDisconnect: null
      Tasks:
      - Affinities: null
        Artifacts: null
        CSIPluginConfig: null
        Config:
          image: redis:3.2
          port_map:
          - db: 6379.0
        Constraints: null
        DispatchPayload: null
        Driver: docker
        Env: null
        KillSignal: ''
        KillTimeout: 5000000000
        Kind: ''
        Leader: false
        Lifecycle: null
        LogConfig:
          MaxFileSizeMB: 10
          MaxFiles: 10
        Meta: null
        Name: redis
        Resources:
          CPU: 500
          Devices: null
          DiskMB: 0
          IOPS: 0
          MemoryMB: 256
          Networks:
          - CIDR: ''
            DNS: null
            Device: ''
            DynamicPorts:
            - HostNetwork: default
              Label: db
              To: 0
              Value: 0
            IP: ''
            MBits: 10
            Mode: ''
            ReservedPorts: null
        RestartPolicy:
          Attempts: 3
          Delay: 15000000000
          Interval: 1800000000000
          Mode: fail
        Services:
        - AddressMode: auto
          CanaryMeta: null
          CanaryTags: null
          Checks:
          - AddressMode: ''
            Args: null
            CheckRestart: null
            Command: ''
            Expose: false
            FailuresBeforeCritical: 0
            GRPCService: ''
            GRPCUseTLS: false
            Header: null
            InitialStatus: ''
            Interval: 10000000000
            Method: ''
            Name: alive
            Path: ''
            PortLabel: ''
            Protocol: ''
            SuccessBeforePassing: 0
            TLSSkipVerify: false
            TaskName: ''
            Timeout: 2000000000
            Type: tcp
          Connect: null
          EnableTagOverride: false
          Meta: null
          Name: redis-cache
          PortLabel: db
          Tags:
          - global
          - cache
          TaskName: ''
        ShutdownDelay: 0
        Templates: null
        User: ''
        Vault: null
        VolumeMounts: null
      Update:
        AutoPromote: false
        AutoRevert: false
        Canary: 0
        HealthCheck: checks
        HealthyDeadline: 180000000000
        MaxParallel: 1
        MinHealthyTime: 10000000000
        ProgressDeadline: 600000000000
        Stagger: 30000000000
      Volumes: null
    Type: service
    Update:
      AutoPromote: false
      AutoRevert: false
      Canary: 0
      HealthCheck: ''
      HealthyDeadline: 0
      MaxParallel: 1
      MinHealthyTime: 0
      ProgressDeadline: 0
      Stagger: 30000000000
    VaultNamespace: ''
    VaultToken: ''
    Version: 0
  type: list

See also

• Nomad jobs documentation: Complete documentation for Nomad API jobs. link