ansible / ansible.builtin / v2.16.0 / filter / comment comment out a string | "added in version" historical of ansible.builtin" Authors: unknownansible.builtin.comment (v2.16.0) — filter
pip
Install with pip install ansible-core==2.16.0
Use programming language conventions to turn the input string into an embeddable comment.
end: description: Indicator the end of a comment block, only available for styles that support multiline comments. type: string style: choices: - plain - decoration - erlang - c - cblock - xml default: plain description: Comment style to use. type: string _input: description: String to comment. required: true type: string prefix: description: Token to start each line inside a comment block, only available for styles that support multiline comments. type: string newline: default: \n description: Indicator of comment end of line, only available for styles that support multiline comments. type: string postfix: description: Indicator of the end of each line inside a comment block, only available for styles that support multiline comments. type: string begining: description: Indicator of the start of a comment block, only available for styles that support multiline comments. type: string decoration: description: Indicator for comment or intermediate comment depending on the style. type: string prefix_count: default: 1 description: Number of times to add a prefix at the start of a line, when a prefix exists and is usable. type: int postfix_count: default: 1 description: Number of times to add a postfix at the end of a line, when a prefix exists and is usable. type: int
_value: description: The 'commented out' string. type: string