35.2. createOrUpdatePath

Name
createOrUpdatePath
Description
Create a new file (text or binary) or directory with the given path, or update an existing path on a server.
Available since: 10.2
Parameters
  • string sessionKey
  • int serverId
  • string path - the configuration file/directory path
  • boolean isDir
    • True - if the path is a directory
    • False - if the path is a file
  • struct - path info
    • string contents - Contents of the file (text or base64 encoded if binary) ((only for non-directories)
    • boolean contents_enc64 - Identifies base64 encoded content (default: disabled, only for non-directories).
    • string owner - Owner of the file/directory.
    • string group - Group name of the file/directory.
    • string permissions - Octal file/directory permissions (eg: 644)
    • string macro-start-delimiter - Config file macro end delimiter. Use null or empty string to accept the default. (only for non-directories)
    • string macro-end-delimiter - Config file macro end delimiter. Use null or empty string to accept the default. (only for non-directories)
    • string selinux_ctx - SeLinux context (optional)
    • int revision - next revision number, auto increment for null
    • boolean binary - mark the binary content, if True, base64 encoded content is expected (only for non-directories)
  • int commitToLocal
    • 1 - to commit configuration files to the system's local override configuration channel
    • 0 - to commit configuration files to the system's sandbox configuration channel
Return Value
  • struct - Configuration Revision information
    • string type
      • file
      • directory
      • symlink
    • string path - File Path
    • string target_path - Symbolic link Target File Path. Present for Symbolic links only.
    • string channel - Channel Name
    • string contents - File contents (base64 encoded according to the contents_enc64 attribute)
    • boolean contents_enc64 - Identifies base64 encoded content
    • int revision - File Revision
    • dateTime.iso8601 creation - Creation Date
    • dateTime.iso8601 modified - Last Modified Date
    • string owner - File Owner. Present for files or directories only.
    • string group - File Group. Present for files or directories only.
    • int permissions - File Permissions (Deprecated). Present for files or directories only.
    • string permissions_mode - File Permissions. Present for files or directories only.
    • string selinux_ctx - SELinux Context (optional).
    • boolean binary - true/false , Present for files only.
    • string sha256 - File's sha256 signature. Present for files only.
    • string macro-start-delimiter - Macro start delimiter for a config file. Present for text files only.
    • string macro-end-delimiter - Macro end delimiter for a config file. Present for text files only.