Description
This operation component changes the access permissions for a file.
Options
Basic Options
Host name or IP address where the file whose access permissions are to be changed resides.
To change the access permission the Management Server, specify the following:
For IPv4: 'localhost' or '127.0.0.1'
For IPv6: 'localhost' or '::1'
An argument error occurs if the host name or IP address is omitted.
The maximum length of the host name or IP address is 1,024 characters. An argument error occurs if this is exceeded.
The name (full path) of the file whose access permissions are to be changed.
An argument error occurs if the file name is omitted.
The maximum length of the file name is 1,024 characters. An argument error occurs if this is exceeded.
Access permission content of the owner of the file to be changed.
Specify execute permission (X), read (R), write (W), or cancel all permissions (C).
Multiple access permissions can be specified.
Specify access permissions as follows:
Permissions content | OS type: Linux or Solaris | OS type: Windows |
|---|---|---|
C | Cancel all permissions | Read only |
X | Execute permissions only | Read only |
W | Write permissions only | Writable |
WX | Write and execute permissions | Writable |
R | Read permissions only | Read only |
RX | Read and execute permissions | Read only |
RW | Read and write permissions | Writable |
RWX | Full control | Writable |
Permissions content must be entered using the letters shown above and in the shown order.
An argument error will occur if any other value for permissions content is specified.
If the access permissions for a file are changed using the file transfer infrastructure and the file is in a Windows environment, the file attributes are changed.
If the access permissions for a file are to be changed on an environment where the OS type is Windows, the attribute of the file is changed.
An argument error occurs if the content of access permissions is omitted.
The maximum length of access permissions content is 1,024 characters. An argument error occurs if this is exceeded.
Access permission content of the owner group of the file to be changed.
Specify execute permission (X), read (R), write (W), or cancel all permissions (C).
Multiple access permissions can be specified.
Specify access permissions as follows:
Permissions content | OS type: Linux or Solaris | OS type: Windows |
|---|---|---|
C | Cancel all permissions | - |
X | Execute permissions only | - |
W | Write permissions only | - |
WX | Write and execute permissions | - |
R | Read permissions only | - |
RX | Read and execute permissions | - |
RW | Read and write permissions | - |
RWX | Full control | - |
Permissions content must be entered using the letters shown above and in the shown order.
An argument error will occur if any other value for permissions content is specified.
If the access permissions for a file are to be changed on an environment where the OS type is Windows, the specified content is invalid.
An argument error occurs if the content of access permissions is omitted.
The maximum length of access permissions content is 1,024 characters. An argument error occurs if this is exceeded.
Access permission content of the other users of the file to be changed.
Specify execute permission (X), read (R), write (W), or cancel all permissions (C).
Multiple access permissions can be specified.
Specify access permissions as follows:
Permissions content | OS type: Linux or Solaris | OS type: Windows |
|---|---|---|
C | Cancel all permissions | - |
X | Execute permissions only | - |
W | Write permissions only | - |
WX | Write and execute permissions | - |
R | Read permissions only | - |
RX | Read and execute permissions | - |
RW | Read and write permissions | - |
RWX | Full control | - |
Permissions content must be entered using the letters shown above and in the shown order.
An argument error will occur if any other value for permissions content is specified.
If the access permissions for a file are to be changed on an environment where the OS type is Windows, the specified content is invalid.
An argument error occurs if the content of access permissions is omitted.
The maximum length of access permissions content is 1,024 bytes. An argument error occurs if this is exceeded.
Advanced Options
OS type of the host changing file access permissions.
Specify Windows, Linux or Solaris. This option is not case sensitive.
If the OS type is omitted, the Configuration Management Database (CMDB) will be searched based on the specified host name or IP address, and Systemwalker Runbook Automation automatically sets the acquired OS type as the value.
The maximum length of the OS type is 1,024 characters. An argument error occurs if this is exceeded.
Name of the user connecting with SSH to the host where the file whose access permissions are to be changed resides.
If the connected user name and password required for connection are not specified, the Configuration Management Database (CMDB) is searched based on the specified host name or IP address and Systemwalker Runbook Automation automatically sets the acquired connected user name as the value.
If the operation component connects with the file transfer infrastructure, the connected user name will be fixed at either of the following names and cannot be changed. In this case, the user name is ignored even if specified.
If the Business Server is running on Windows: SYSTEM user
If the Business Server is running on Linux or Solaris: root
The maximum length of the connected user name is 1,024 characters. Argument error occurs if this is exceeded.
Password of the user connecting with SSH to the host where the file whose access permissions are to be changed resides.
If the connected user name and password required for connection are not specified, the Configuration Management Database (CMDB) is searched based on the specified host name or IP address and Systemwalker Runbook Automation automatically sets the acquired connected user name as the value.
If it connects with file transfer infrastructure, the connected user password is invalid.
The maximum length of the connected user password is 1,024 characters. Argument error occurs if this is exceeded.
Name of the user changing access permissions on the host where the file whose access permissions are to be changed resides.
If the "execusername" and "execpassword" are not specified, the Configuration Management Database (CMDB) is searched based on the specified host name or IP address and Systemwalker Runbook Automation automatically sets the acquired administrator user as the value.
If not to register to CMDB, it is executed by name of the user connecting.
If the host specified in "hostname" is Windows and it connects with the file transfer infrastructure, execute the command as a SYSTEM user. In this case, the connected user name is invalid.
The maximum length of the user name is 1,024 characters. An argument error occurs if this is exceeded.
This operation component does not use the value of "execpassword". The value of "execpassword" is ignored even if specified.
This is the completion timeout (seconds) for the execution of operation components.
Values between 300 and 86400 (1 day) can be specified.
For example: When timeout is to occur every 10 minutes: 600
When the execution of the operation components is not completed even if the specified time passes, the processing of the operation components is interrupted in return value 201.
This is the retry count for the execution of operation components.
When the operation components end in return value 161, the retry count is specified. Values between 0 and 5 can be specified.
As a result of retrying, if the operation components ended by the return values other than 161, the execution of the operation components ends even if it doesn't reach the specified retry count. The return values of the operation components become the value executed at the end.
For example: When retries are to be performed twice: 2
This is the retry interval (seconds) for operation components.
When the operation components end in return value 161, the retry interval is specified. Values between 1 and 14400 can be specified.
For example: When retrying in 300 seconds: 300
If the specification of the timeout, retry, and retry_interval is omitted, and a value beyond the limits of the above-mentioned is input, the value specified with the operation components definition file becomes effective. Refer to "2.5 Definition File for Operation Components" for details.
Return Values
Icon | Name | Return value | Description |
|---|---|---|---|
| Success | 0 | Changing access permissions of the file was successful. |
| Failure | 161 | Failed to change access permissions of the file. Retried if a retry count has been specified. |
177 | Failed to access the file. | ||
187 | Authentication failed when an attempt was made to connect to the Business Server over a network (using SSH). Alternatively, an error occurred during the processing of communications with the Business Server (file transfer infrastructure). In this case, the error code for the file transfer infrastructure is output to the execution results. Refer to "3.21 Detailed Code of File Transfer Infrastructure" for information on error codes. | ||
188 | When an operation component was performing an operation on a Business Server where an RBA Agent has not been installed, the network communications (SSH) with the Business Server was closed. | ||
189 | An attempt to connect to the Business Server over the network (using SSH) failed. Alternatively, an error occurred during the processing of communications with the Business Server (file transfer infrastructure). In this case, the error code for the file transfer infrastructure is output to the execution results. Refer to "3.21 Detailed Code of File Transfer Infrastructure" for information on error codes. | ||
197 | There is an error in the input information. | ||
200 | Changing access permissions of the file terminated abnormally. | ||
- | - | 201 | Execution of operation component timed out. |
202 | The operation component was not executed. There is a problem in the setting to execute operation components. | ||
203 | Failed to execute the operation component. There is a problem in the Operation Automation Server environment. | ||
205 | The operation component was not executed. There is a problem with the input information specification of the operation component. | ||
206 | The operation component was not executed normally. There is a problem with the output information specification of the operation component. | ||
207 | The operation components were not executed. There is a possibility that the operation components are not registered in the Management Server. | ||
208 | The Automated Operation Process has been canceled because the Automated Operation Process was recovered while the operation component was executing. |
Output information
Variable | Description |
|---|---|
message | This variable will be set to the following message if the access permissions for the file are changed successfully. The operation component was successful. If changing the access permissions for the file fails, the content of the error will be output as a string. |
returnCode | This variable is set to the return value. |
Notes
This operation component uses File Transfer Infrastructure or SSH communication to perform its operations when specify the host name other than the Management Server. It is necessary to be able to connect at least each one. Refer to "3.16 Notes of Each Communication Method" for information on communication methods.
Refer to "3.16.7 Notes When Connected User And Executing User Are Different" for information on different connected and executing users.
Use alphanumeric characters and white space and full width characters, and the symbols below for the names of the file to change access permissions.
Symbols that can be used: "!","~","_","-","."
If the specified filename is a symbolic link, the access permissions to the linked file will be changed.
Confirm the return values with the Web console. Refer to "Confirming the Operation Component Execution Status/Execution Results" in the Systemwalker Runbook Automation Operation Guide for details.
When the return value of 201-208 is output, the Automated Operation Process enters an abort or error state, and the error message is output to the following places.
Event log of Management Server (when the Management Server is Windows(R))
System log of Management Server (when the Management Server is Linux)
Custom message of BPMN
Confirm the message in either of the above-mentioned place, and take an appropriate action. Refer to the Systemwalker Runbook Automation Message Guide for details.
