broadcom.ops.enable_rule (4.1.8) — module

Install collection

Install with ansible-galaxy collection install broadcom.ops:==4.1.8

Add to requirements.yml

  collections:
    - name: broadcom.ops
      version: 4.1.8

Description

Enable the specified rule.

Usage examples

Scanned by Steampunk Spotter

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

- name: Enable MYRULE on ruleset OPSRULES on subsystem OPSS.
  broadcom.ops.enable_rule:
    ruleset: OPSRULES
    rule: MYRULE
    subsystem: OPSS

Inputs

    
host:
    description:
    - The hostname of the server where OPS Web Services is running.
    required: false
    type: str

port:
    description:
    - The port number for OPS Web Services.
    required: false
    type: int

rule:
    description:
    - The name of the rule.
    required: true
    type: str

user:
    description:
    - Your z/OS user name used to authenticate to OPS Web Services.
    required: false
    type: str

ruleset:
    description:
    - The rule set containing the rule.
    required: true
    type: str

password:
    description:
    - Your z/OS password used to authenticate to OPS Web Services.
    required: false
    type: str

protocol:
    choices:
    - http
    - https
    default: https
    description:
    - The protocol used for connecting to OPS Web Services.
    required: true
    type: str

cert_file:
    description:
    - The file path to a certificate file to use for authentication.
    - ''
    - 'Note: The CLI does not support certificate files that require a password. For more
      information, search Troubleshooting PEM Certificates in Zowe Docs.'
    required: false
    type: path

subsystem:
    description:
    - Specifies the subsystem id of the OPS/MVS instance to which commands will be directed.
    required: false
    type: str

cert_key_file:
    description:
    - The file path to a certificate key file to use for authentication.
    required: false
    type: path

reject_unauthorized:
    default: true
    description:
    - If set to true, the server certificate is verified against the list of supplied
      CAs. If set to false, certificate verification is not performed.
    required: false
    type: bool

Outputs

data:
  description: Data from the module execution (a data structure). The items of this
    dict are set as individual return values on the top level as well.
  elements: dict
  returned: when returned data is a dictionary
  type: list
error:
  contains:
    additional_details:
      description: Detailed message about the failure.
      type: str
    msg:
      description: Short description of the result or failure.
      type: str
    request:
      description: HTTP method used to invoke API service request.
      returned: API request failed
      type: str
    resource:
      description: URI of the resource of the API service request.
      returned: API request failed
      type: str
  description: More details about why the action has failed. If the failure is when
    calling an API service, the response contains the connection parameters.
  returned: error
  type: complex
failed:
  description: A boolean that indicates if the task was failed or not.
  returned: always
  type: bool
list:
  description: Data from the module execution (a list of data structures).
  elements: dict
  returned: when returned data is a list
  type: list
msg:
  description: Short description of the result or failure.
  returned: sometimes
  type: str
rc:
  description: Exit code of the module, successful exit code is 0, failure is typically
    1 or higher.
  returned: always
  type: int
stderr:
  description: Details of the error.
  returned: error
  type: str
stdout:
  description: Summary of the result.
  returned: success
  type: str