RenameFile

RenameFile

SYNOPSIS

Renames specified file.

SYNTAX

  - ActionType: RenameFile
    ActionDescription: 
    FileName:
    NewFileName: 
    Overwrite: 
    ExactVariableCheck: 

EXAMPLES

EXAMPLE 1

  - ActionType: RenameFile
    ActionDescription: Rename log file
    FileName: D:\log.txt
    NewFileName: D:\log.txt.bak
    Overwrite: true
    ExactVariableCheck: false

EXAMPLE 2

  - ActionType: RenameFile
    FileName: D:\log.txt
    NewFileName: D:\log.txt.bak

EXAMPLE 3

  - ActionType: RenameFile
    FileName: $varFileName
    NewFileName: $varNewName

PARAMETERS

ActionType

This parameter specifies action name. RenameFile value is required for this action to be executed.

Required: true
Default Value: RenameFile
Accepted Value: RenameFile
Accepted Value Type: string
Accepts Variables: false

ActionDescription

This parameter specifies description of the action.

Required: false
Default Value: none
Accepted Value: any
Accepted Value Type: string
Accepts Variables: false

FileName

This parameter specifies absolute path to file which should be renamed.

Required: true
Default Value: none
Accepted Value: any
Accepted Value Type: string
Accepts Variables: true

NewFileName

This parameter specifies absolute path to file should be renamed to.

Required: true
Default Value: none
Accepted Value: any
Accepted Value Type: string
Accepts Variables: true

Overwrite

This parameter specifies if file should be overwritten in the destination path if it already exists there.

Required: false
Default Value: false
Accepted Value: true\false
Accepted Value Type: boolean
Accepts Variables: true

ExactVariableCheck

This parameter specifies how to check YAML file variables specified in other parameters. If value is:

• true - variable value will be set when it is a separated word. Example: $var1$var2 will not be considered as $var1 and $var2.
• false - variable value will be set even if it is not separated word . Example: $var1$var2 will be considered as $var1 and $var2.

Required: false
Default Value: none
Accepted Value: true\false
Accepted Value Type: boolean
Accepts Variables: false

NOTES