infoblox.nios_modules.nios_restartservices (1.6.1) — module

Install collection

Install with ansible-galaxy collection install infoblox.nios_modules:==1.6.1

Add to requirements.yml

  collections:
    - name: infoblox.nios_modules
      version: 1.6.1

Description

Restart grid services.

When invoked without any options, will restart ALL services on the default restart group IF NEEDED.

Requirements

• infoblox-client

Usage examples

Scanned by Steampunk Spotter

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

- name: Restart all grid services if needed.
  infoblox.nios_modules.nios_restartservices:
    provider:
      host: "{{ inventory_hostname_short }}"
      username: admin
      password: admin
  connection: local

Scanned by Steampunk Spotter

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

- name: Restart DNS service if needed.
  infoblox.nios_modules.nios_restartservices:
    services:
      - DNS
    provider:
      host: "{{ inventory_hostname_short }}"
      username: admin
      password: admin
  connection: local

Inputs

    
mode:
    choices:
    - GROUPED
    - SEQUENTIAL
    - SIMULTANEOUS
    description:
    - The restart method in case of grid restart.
    required: false
    type: str

groups:
    description:
    - The list of the Service Restart Groups to restart.
    elements: str
    required: false
    type: list

members:
    description:
    - The list of the Grid Members to restart.
    elements: str
    required: false
    type: list

provider:
    description:
    - A dict object containing connection details.
    suboptions:
      cert:
        description:
        - Specifies the client certificate file with digest of x509 config for extra layer
          secure connection the remote instance of NIOS.
        - Value can also be specified using C(INFOBLOX_CERT) environment variable.
        type: str
      host:
        description:
        - Specifies the DNS host name or address for connecting to the remote instance
          of NIOS WAPI over REST
        - Value can also be specified using C(INFOBLOX_HOST) environment variable.
        type: str
      http_pool_connections:
        default: 10
        description:
        - Insert decription here
        type: int
      http_pool_maxsize:
        default: 10
        description:
        - Insert description here
        type: int
      http_request_timeout:
        default: 10
        description:
        - The amount of time before to wait before receiving a response
        - Value can also be specified using C(INFOBLOX_HTTP_REQUEST_TIMEOUT) environment
          variable.
        type: int
      key:
        description:
        - Specifies private key file for encryption with the certificate in order to connect
          with remote instance of NIOS.
        - Value can also be specified using C(INFOBLOX_KEY) environment variable.
        type: str
      max_results:
        default: 1000
        description:
        - Specifies the maximum number of objects to be returned, if set to a negative
          number the appliance will return an error when the number of returned objects
          would exceed the setting.
        - Value can also be specified using C(INFOBLOX_MAX_RESULTS) environment variable.
        type: int
      max_retries:
        default: 3
        description:
        - Configures the number of attempted retries before the connection is declared
          usable
        - Value can also be specified using C(INFOBLOX_MAX_RETRIES) environment variable.
        type: int
      password:
        description:
        - Specifies the password to use to authenticate the connection to the remote instance
          of NIOS.
        - Value can also be specified using C(INFOBLOX_PASSWORD) environment variable.
        type: str
      silent_ssl_warnings:
        default: true
        description:
        - Insert description here
        type: bool
      username:
        description:
        - Configures the username to use to authenticate the connection to the remote
          instance of NIOS.
        - Value can also be specified using C(INFOBLOX_USERNAME) environment variable.
        type: str
      validate_certs:
        aliases:
        - ssl_verify
        default: false
        description:
        - Boolean value to enable or disable verifying SSL certificates
        - Value can also be specified using C(INFOBLOX_SSL_VERIFY) environment variable.
        type: bool
      wapi_version:
        default: '2.9'
        description:
        - Specifies the version of WAPI to use
        - Value can also be specified using C(INFOBLOX_WAPI_VERSION) environment variable.
        - Until ansible 2.8 the default WAPI was 1.4
        type: str
    type: dict

services:
    choices:
    - ALL
    - DNS
    - DHCP
    - DHCPV4
    - DHCPV6
    default: ALL
    description:
    - The list of services the restart applicable to.
    elements: str
    required: false
    type: list

restart_option:
    choices:
    - RESTART_IF_NEEDED
    - FORCE_RESTART
    default: RESTART_IF_NEEDED
    description:
    - Controls whether services are restarted unconditionally or when needed
    required: false
    type: str