update_sync_back_settings – Update sync-back

Synopsis

Update sync-back schedule used by Endevor Bridge for Git.

Parameters

context (type: str)

Git-Endevor mapping context (ID of the organization, project, team, or the Git repository owner).

mapping (type: str)

Git-Endevor mapping name (Git repository ID).

enabled (type: bool, default: True)

Indicates if the sync-back option is enabled or disables one if set to false.

overwrite (type: bool, default: True)

Overwrites (true) or inherits (false) the global sync-back settings.

start_date (type: str)

Indicates the start date of the sync-back schedule in UTC time zone. Format YYYY-MM-DD.

start_time (type: str)

Indicates the start time of the sync-back schedule in UTC time zone. Format HH:MM:SS (24 hour format).

interval (required, type: int)

Specifies the number of time interval units for a scheduled sync-back run.

time_unit (required, type: str)

Specifies a time unit for the scheduled sync-back run interval.

Choices:

  • MINUTES

  • HOURS

  • DAYS

  • WEEKS

  • MONTHS

protocol (required, type: str)

Endevor Bridge for Git SCM protocol.

Default: https.

Choices:

  • http

  • https

host (required, type: str)

Endevor Bridge for Git hostname.

port (required, type: int)

Endevor Bridge for Git port.

user (required, type: str)

Endevor Bridge for Git username (your git username).

token (required, type: str)

Git personal access token (Obtain the token from your Git Enterprise Server).

reject_unauthorized (type: bool)

Reject self-signed certificates.

Default: false.

ebg_base_path (type: str)

The Endevor Bridge for Git Rest API base path.

password (type: str)

Password to authenticate to service on the mainframe.

cert_file (type: path)

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.

cert_key_file (type: path)

The file path to a certificate key file to use for authentication.

Examples

- name: Update global sync-back schedule from the mapped Endevor locations
  broadcom.endevor_bridge_for_git.update_sync_back_settings:
    interval: 1

- name: Update a mapping sync-back schedule from the mapped Endevor locations
  broadcom.endevor_bridge_for_git.update_sync_back_settings:
    context: MY-CONTEXT
    mapping: MY-MAPPING
    enabled: y
    overwrite: y
    interval: 1

Return Values

data (type: list, when returned data is a dictionary)

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.

error (type: complex, error)

More details about why the action has failed. If the failure is when calling an API service, the response contains the connection parameters.

additional_details (type: str)

Detailed message about the failure.

msg (type: str)

Short description of the result or failure.

request (type: str, API request failed)

HTTP method used to invoke API service request.

resource (type: str, API request failed)

URI of the resource of the API service request.

failed (type: bool, always)

A boolean that indicates if the task was failed or not.

list (type: list, when returned data is a list)

Data from the module execution (a list of data structures).

msg (type: str, sometimes)

Short description of the result or failure.

rc (type: int, always)

Exit code of the module, successful exit code is 0, failure is typically 1 or higher.

stderr (type: str, error)

Details of the error.

stdout (type: str, success)

Summary of the result.

Status

  • This module is maintained by Broadcom.