# Pipeline ## pipeline This is a module that supports creating, updating or destroying Pipelines ### Example Syntax ```yaml name: Create Pipeline ionoscloudsdk.ionoscloud.pipeline: name: 'ansiblepipelinetest' logs: '[{'source': 'kubernetes', 'tag': 'tag', 'protocol': 'http', 'destinations': [{'type': 'loki', 'retention_in_days': 7}]}]' wait: true wait_timeout: 1200 register: pipeline_response name: Update pipeline ionoscloudsdk.ionoscloud.pipeline: pipeline: '' name: 'ansiblepipeNEW' logs: '[{'source': 'docker', 'tag': 'differenttag', 'protocol': 'tcp', 'labels': ['1'], 'destinations': [{'type': 'loki', 'retention_in_days': 14}]}, {'source': 'kubernetes', 'tag': 'updatedtag', 'protocol': 'http', 'labels': ['2'], 'destinations': [{'type': 'loki', 'retention_in_days': 14}]}]' state: update register: updated_pipeline_response name: Delete pipeline ionoscloudsdk.ionoscloud.pipeline: pipeline: '' wait: true state: absent name: Renew Pipeline key ionoscloudsdk.ionoscloud.pipeline: pipeline: '' state: renew ``` ### Returned object ```json { "changed": true, "failed": false, "action": "update", "pipeline": { "id": "f30a1c8f-334d-4238-b259-b0a761a87352", "type": "Pipeline", "metadata": { "created_date": "2023-10-17T15:19:14+00:00", "created_by": "", "created_by_user_id": "", "created_by_user_uuid": "", "last_modified_date": "2023-10-17T15:21:02+00:00", "last_modified_by": "", "last_modified_by_user_id": "", "last_modified_by_user_uuid": "", "status": "AVAILABLE" }, "properties": { "name": "ansiblepipelinetest123UPDATED", "logs": [ { "public": false, "source": "docker", "tag": "differenttag", "protocol": "tcp", "labels": [ "new_label" ], "destinations": [ { "type": "loki", "retention_in_days": 14 } ] }, { "public": false, "source": "kubernetes", "tag": "updatedtag", "protocol": "http", "labels": [ "label" ], "destinations": [ { "type": "loki", "retention_in_days": 14 } ] } ], "tcp_address": "", "http_address": "", "grafana_address": "" } } } ``` #### For more examples please check out the tests [here](https://github.com/ionos-cloud/module-ansible/tree/master/tests/logging). ## state: **present** ```yaml name: Create Pipeline ionoscloudsdk.ionoscloud.pipeline: name: 'ansiblepipelinetest' logs: '[{'source': 'kubernetes', 'tag': 'tag', 'protocol': 'http', 'destinations': [{'type': 'loki', 'retention_in_days': 7}]}]' wait: true wait_timeout: 1200 register: pipeline_response ``` #### Available parameters for state **present**:

Name	Required	Description
name str	True	The name of the pipeline. Must be not more that 20 characters long.
logs list	True	The information of the log pipelines
api_url str	False	The Ionos API base URL.
certificate_fingerprint str	False	The Ionos API certificate fingerprint.
username str	False	The Ionos username. Overrides the IONOS_USERNAME environment variable.
password str	False	The Ionos password. Overrides the IONOS_PASSWORD environment variable.
token str	False	The Ionos token. Overrides the IONOS_TOKEN environment variable.
wait bool	False	Wait for the resource to be created before returning. Default: True Options: [True, False]
wait_timeout int	False	How long before wait gives up, in seconds. Default: 600
state str	False	Indicate desired state of the resource. Default: present Options: ['present', 'absent', 'update', 'renew']

## state: **absent** ```yaml name: Delete pipeline ionoscloudsdk.ionoscloud.pipeline: pipeline: '' wait: true state: absent ``` #### Available parameters for state **absent**:

Name	Required	Description
pipeline str	True	The ID or name of an existing Pipeline.
api_url str	False	The Ionos API base URL.
certificate_fingerprint str	False	The Ionos API certificate fingerprint.
username str	False	The Ionos username. Overrides the IONOS_USERNAME environment variable.
password str	False	The Ionos password. Overrides the IONOS_PASSWORD environment variable.
token str	False	The Ionos token. Overrides the IONOS_TOKEN environment variable.
wait bool	False	Wait for the resource to be created before returning. Default: True Options: [True, False]
wait_timeout int	False	How long before wait gives up, in seconds. Default: 600
state str	False	Indicate desired state of the resource. Default: present Options: ['present', 'absent', 'update', 'renew']

## state: **update** ```yaml name: Update pipeline ionoscloudsdk.ionoscloud.pipeline: pipeline: '' name: 'ansiblepipeNEW' logs: '[{'source': 'docker', 'tag': 'differenttag', 'protocol': 'tcp', 'labels': ['1'], 'destinations': [{'type': 'loki', 'retention_in_days': 14}]}, {'source': 'kubernetes', 'tag': 'updatedtag', 'protocol': 'http', 'labels': ['2'], 'destinations': [{'type': 'loki', 'retention_in_days': 14}]}]' state: update register: updated_pipeline_response ``` #### Available parameters for state **update**:

Name	Required	Description
name str	False	The name of the pipeline. Must be not more that 20 characters long.
logs list	False	The information of the log pipelines
pipeline str	True	The ID or name of an existing Pipeline.
api_url str	False	The Ionos API base URL.
certificate_fingerprint str	False	The Ionos API certificate fingerprint.
username str	False	The Ionos username. Overrides the IONOS_USERNAME environment variable.
password str	False	The Ionos password. Overrides the IONOS_PASSWORD environment variable.
token str	False	The Ionos token. Overrides the IONOS_TOKEN environment variable.
wait bool	False	Wait for the resource to be created before returning. Default: True Options: [True, False]
wait_timeout int	False	How long before wait gives up, in seconds. Default: 600
state str	False	Indicate desired state of the resource. Default: present Options: ['present', 'absent', 'update', 'renew']

## state: **renew** ```yaml name: Renew Pipeline key ionoscloudsdk.ionoscloud.pipeline: pipeline: '' state: renew ``` #### Available parameters for state **renew**:

Name	Required	Description
pipeline str	True	The ID or name of an existing Pipeline.
api_url str	False	The Ionos API base URL.
certificate_fingerprint str	False	The Ionos API certificate fingerprint.
username str	False	The Ionos username. Overrides the IONOS_USERNAME environment variable.
password str	False	The Ionos password. Overrides the IONOS_PASSWORD environment variable.
token str	False	The Ionos token. Overrides the IONOS_TOKEN environment variable.
wait bool	False	Wait for the resource to be created before returning. Default: True Options: [True, False]
wait_timeout int	False	How long before wait gives up, in seconds. Default: 600
state str	False	Indicate desired state of the resource. Default: present Options: ['present', 'absent', 'update', 'renew']

--- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.ionos.com/ansible/api/logging/modules/pipeline.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.