Class: Ansible::Ruby::Modules::Win_lineinfile

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/windows/win_lineinfile.rb

Overview

This module will search a file for a line, and ensure that it is present or absent. This is primarily useful when you want to change a single line in a file only.

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, fix_inclusion, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#backrefs ⇒ :yes, ...

Returns Used with C(state=present). If set, line can contain backreferences (both positional and named) that will get populated if the C(regexp) matches. This flag changes the operation of the module slightly; C(insertbefore) and C(insertafter) will be ignored, and if the C(regexp) doesn’t match anywhere in the file, the file will be left unchanged.,If the C(regexp) does match, the last matching line will be replaced by the expanded line parameter.

Returns:

  • (:yes, :no, nil) —

    Used with C(state=present). If set, line can contain backreferences (both positional and named) that will get populated if the C(regexp) matches. This flag changes the operation of the module slightly; C(insertbefore) and C(insertafter) will be ignored, and if the C(regexp) doesn’t match anywhere in the file, the file will be left unchanged.,If the C(regexp) does match, the last matching line will be replaced by the expanded line parameter.



29
 
# File 'lib/ansible/ruby/modules/generated/windows/win_lineinfile.rb', line 29

attribute :backrefs

#backup ⇒ :yes, ...

Returns Create a backup file including the timestamp information so you can get the original file back if you somehow clobbered it incorrectly.

Returns:

  • (:yes, :no, nil) —

    Create a backup file including the timestamp information so you can get the original file back if you somehow clobbered it incorrectly.



45
 
# File 'lib/ansible/ruby/modules/generated/windows/win_lineinfile.rb', line 45

attribute :backup

#create ⇒ :yes, ...

Returns Used with C(state=present). If specified, the file will be created if it does not already exist. By default it will fail if the file is missing.

Returns:

  • (:yes, :no, nil) —

    Used with C(state=present). If specified, the file will be created if it does not already exist. By default it will fail if the file is missing.



41
 
# File 'lib/ansible/ruby/modules/generated/windows/win_lineinfile.rb', line 41

attribute :create

#encoding ⇒ String?

Returns Specifies the encoding of the source text file to operate on (and thus what the output encoding will be). The default of C(auto) will cause the module to auto-detect the encoding of the source file and ensure that the modified file is written with the same encoding.,An explicit encoding can be passed as a string that is a valid value to pass to the .NET framework System.Text.Encoding.GetEncoding() method - see U(msdn.microsoft.com/en-us/library/system.text.encoding%28v=vs.110%29.aspx).,This is mostly useful with C(create=yes) if you want to create a new file with a specific encoding. If C(create=yes) is specified without a specific encoding, the default encoding (UTF-8, no BOM) will be used.

Returns:

  • (String, nil) —

    Specifies the encoding of the source text file to operate on (and thus what the output encoding will be). The default of C(auto) will cause the module to auto-detect the encoding of the source file and ensure that the modified file is written with the same encoding.,An explicit encoding can be passed as a string that is a valid value to pass to the .NET framework System.Text.Encoding.GetEncoding() method - see U(msdn.microsoft.com/en-us/library/system.text.encoding%28v=vs.110%29.aspx).,This is mostly useful with C(create=yes) if you want to create a new file with a specific encoding. If C(create=yes) is specified without a specific encoding, the default encoding (UTF-8, no BOM) will be used.



52
 
# File 'lib/ansible/ruby/modules/generated/windows/win_lineinfile.rb', line 52

attribute :encoding

#insertafter ⇒ :EOF, ...

Returns Used with C(state=present). If specified, the line will be inserted after the last match of specified regular expression. A special value is available; C(EOF) for inserting the line at the end of the file.,If specified regular expression has no matches, EOF will be used instead. May not be used with C(backrefs).

Returns:

  • (:EOF, :"*regex*", nil) —

    Used with C(state=present). If specified, the line will be inserted after the last match of specified regular expression. A special value is available; C(EOF) for inserting the line at the end of the file.,If specified regular expression has no matches, EOF will be used instead. May not be used with C(backrefs).



33
 
# File 'lib/ansible/ruby/modules/generated/windows/win_lineinfile.rb', line 33

attribute :insertafter

#insertbefore ⇒ :BOF, ...

Returns Used with C(state=present). If specified, the line will be inserted before the last match of specified regular expression. A value is available; C(BOF) for inserting the line at the beginning of the file.,If specified regular expression has no matches, the line will be inserted at the end of the file. May not be used with C(backrefs).

Returns:

  • (:BOF, :"*regex*", nil) —

    Used with C(state=present). If specified, the line will be inserted before the last match of specified regular expression. A value is available; C(BOF) for inserting the line at the beginning of the file.,If specified regular expression has no matches, the line will be inserted at the end of the file. May not be used with C(backrefs).



37
 
# File 'lib/ansible/ruby/modules/generated/windows/win_lineinfile.rb', line 37

attribute :insertbefore

#line ⇒ String?

Returns Required for C(state=present). The line to insert/replace into the file. If C(backrefs) is set, may contain backreferences that will get expanded with the C(regexp) capture groups if the regexp matches.,Be aware that the line is processed first on the controller and thus is dependent on yaml quoting rules. Any double quoted line will have control characters, such as ‘rn’, expanded. To print such characters literally, use single or no quotes.

Returns:

  • (String, nil) —

    Required for C(state=present). The line to insert/replace into the file. If C(backrefs) is set, may contain backreferences that will get expanded with the C(regexp) capture groups if the regexp matches.,Be aware that the line is processed first on the controller and thus is dependent on yaml quoting rules. Any double quoted line will have control characters, such as ‘rn’, expanded. To print such characters literally, use single or no quotes.



25
 
# File 'lib/ansible/ruby/modules/generated/windows/win_lineinfile.rb', line 25

attribute :line

#newline ⇒ :unix, ...

Returns Specifies the line separator style to use for the modified file. This defaults to the windows line separator (C(rn)). Note that the indicated line separator will be used for file output regardless of the original line separator that appears in the input file.

Returns:

  • (:unix, :windows, nil) —

    Specifies the line separator style to use for the modified file. This defaults to the windows line separator (C(rn)). Note that the indicated line separator will be used for file output regardless of the original line separator that appears in the input file.



56
 
# File 'lib/ansible/ruby/modules/generated/windows/win_lineinfile.rb', line 56

attribute :newline

#path ⇒ String

Returns The path of the file to modify.,Note that the Windows path delimiter C() must be escaped as C(\) when the line is double quoted.,Before 2.3 this option was only usable as I(dest), I(destfile) and I(name).

Returns:

  • (String) —

    The path of the file to modify.,Note that the Windows path delimiter C() must be escaped as C(\) when the line is double quoted.,Before 2.3 this option was only usable as I(dest), I(destfile) and I(name).



13
 
# File 'lib/ansible/ruby/modules/generated/windows/win_lineinfile.rb', line 13

attribute :path

#regexp ⇒ String?

Returns The regular expression to look for in every line of the file. For C(state=present), the pattern to replace if found; only the last line found will be replaced. For C(state=absent), the pattern of the line to remove. Uses .NET compatible regular expressions; see U(msdn.microsoft.com/en-us/library/hs600312%28v=vs.110%29.aspx).

Returns:

  • (String, nil) —

    The regular expression to look for in every line of the file. For C(state=present), the pattern to replace if found; only the last line found will be replaced. For C(state=absent), the pattern of the line to remove. Uses .NET compatible regular expressions; see U(msdn.microsoft.com/en-us/library/hs600312%28v=vs.110%29.aspx).



17
 
# File 'lib/ansible/ruby/modules/generated/windows/win_lineinfile.rb', line 17

attribute :regexp

#state ⇒ :absent, ...

Returns Whether the line should be there or not.

Returns:

  • (:absent, :present, nil) —

    Whether the line should be there or not.



21
 
# File 'lib/ansible/ruby/modules/generated/windows/win_lineinfile.rb', line 21

attribute :state

#validate ⇒ Object?

Returns Validation to run before copying into place. Use %s in the command to indicate the current file to validate.,The command is passed securely so shell features like expansion and pipes won’t work.

Returns:

  • (Object, nil) —

    Validation to run before copying into place. Use %s in the command to indicate the current file to validate.,The command is passed securely so shell features like expansion and pipes won’t work.



49
 
# File 'lib/ansible/ruby/modules/generated/windows/win_lineinfile.rb', line 49

attribute :validate