Skip to content
This repository has been archived by the owner on Apr 24, 2019. It is now read-only.

Commit

Permalink
Replace all agent/manager wording from lowercase to upper case
Browse files Browse the repository at this point in the history
  • Loading branch information
root authored and DeepSecurityOpenSourceSupport committed Jul 27, 2018
1 parent b16d641 commit 58a3f67
Showing 1 changed file with 17 additions and 17 deletions.
34 changes: 17 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Ansible

An Ansible playbook for the Deep Security Agent. This playbook allows you to easily deploy the Deep Security Agent as well as take some common operations from the agent.
An Ansible playbook for the Deep Security Agent. This playbook allows you to easily deploy the Deep Security Agent as well as take some common operations from the Agent.

## Support

Expand All @@ -26,7 +26,7 @@ There are no dependencies.

Below are sample usages for the playbook:

##### For deploying agents to a non-multi-tenant Deep Security Manager
##### For deploying Agents to a non-multi-tenant Deep Security Manager
```yaml
- hosts: all
roles:
Expand All @@ -41,7 +41,7 @@ Below are sample usages for the playbook:
force_reactivation: false
```
##### For deploying agents to a multi-tenant Deep Security Manager (like Deep Security as a Service)
##### For deploying Agents to a multi-tenant Deep Security Manager (like Deep Security as a Service)
```yaml
- hosts: all
roles:
Expand All @@ -65,12 +65,12 @@ Definition for possible operations to be performed in this role, for required va
Operation | Description | Variables
------------|-------------|-------------------
deploy | The <code>deploy</code> task includes the <code>install</code> and <code>activate</code> playbooks internally. | dsm_agent_download_hostname <br /> dsm_agent_download_port <br /> dsm_agent_activation_hostname <br/> dsm_agent_activation_port <br/> policy_id/policy_name (Optional) <br/> group_id (Optional) <br/> force_reactivation (Optional) <br/><br/> **For multi-tenancy only:** <br/> tenant_id <br /> token/tenant_password
install | The install task downloads and installs the Deep Security Agent. The installation is skipped if an agent of the same version is already installed. If a newer version of Deep Security Installer is already installed, then the version is upgraded. | dsm_agent_download_hostname <br/> dsm_agent_download_port
activate | The activate task activates the Deep Security Agent by registering it in Trend Micro Deep Security Manager. By default, activation is skipped if the agent is already activated, unless the force_reactivation attribute is set to true. | dsm_agent_activation_hostname <br/> dsm_agent_activation_port <br/> policy_id/policy_name (Optional) <br/> group_id (Optional) <br/> force_reactivation (Optional) <br/><br/> **For multi-tenancy only:** <br/> tenant_id <br/> token/tenant_password
set-policy-by-id | Change the agent's policy via policy id | policy_id
set-policy-by-name | Change the agent's policy via policy name | policy_name
check-in-with-manager | Ask the agent to contact the manager now. | N/A
create-diagnostic-package | Generate an agent diagnostic package. | N/A
install | The install task downloads and installs the Deep Security Agent. The installation is skipped if an Agent of the same version is already installed. If a newer version of Deep Security Installer is already installed, then the version is upgraded. | dsm_agent_download_hostname <br/> dsm_agent_download_port
activate | The activate task activates the Deep Security Agent by registering it in Trend Micro Deep Security Manager. By default, activation is skipped if the Agent is already activated, unless the force_reactivation attribute is set to true. | dsm_agent_activation_hostname <br/> dsm_agent_activation_port <br/> policy_id/policy_name (Optional) <br/> group_id (Optional) <br/> force_reactivation (Optional) <br/><br/> **For multi-tenancy only:** <br/> tenant_id <br/> token/tenant_password
set-policy-by-id | Change the Agent's policy via policy id | policy_id
set-policy-by-name | Change the Agent's policy via policy name | policy_name
check-in-with-manager | Ask the Agent to contact the Manager now. | N/A
create-diagnostic-package | Generate an Agent diagnostic package. | N/A
create-integrity-baseline | Rebuild the integrity monitoring baseline on the computer. | N/A
run-recommendation-scans | Initiate a recommendation scan on the computer. | N/A
scan-for-integrity-changes | Scan for changes for integrity monitoring | N/A
Expand All @@ -84,16 +84,16 @@ Key | Type | Description | Sample
----|------|-------------|--------
action | String | Name of the operation to be performed **(deprecated&mdash;please use operation instead)** | See [Operations](#operations)
operation | String | Name of the operation to be performed | See [Operations](#operations)
dsm_agent_activation_hostname | String | The hostname for the agents to communicate with once deployed. For Marketplace and software deployments, this is typically the same hostname as 'dsm_agent_download_hostname'. | agents.deepsecurity.trendmicro.com
dsm_agent_activation_port | Integer | The port used for the agent heartbeat (the regular communication). For Marketplace and software deployments, the default is 4120. | 443
dsm_agent_activation_hostname | String | The hostname for the Agents to communicate with once deployed. For Marketplace and software deployments, this is typically the same hostname as 'dsm_agent_download_hostname'. | agents.deepsecurity.trendmicro.com
dsm_agent_activation_port | Integer | The port used for the Agent heartbeat (the regular communication). For Marketplace and software deployments, the default is 4120. | 443
dsm_agent_download_hostname | String | The hostname of the Deep Security Manager. | app.deepsecurity.trendmicro.com
dsm_agent_download_port | Integer | The port to connect to the Deep Security Manager to download the agents. This is typically the same port as the one used to access the Deep Security Manager administration interface. | 443
dsm_agent_download_port | Integer | The port to connect to the Deep Security Manager to download the Agents. This is typically the same port as the one used to access the Deep Security Manager administration interface. | 443
force_reactivation | Boolean | Force re-activation even if the Deep Security Agent has already been activated. | false
group_id | String | The Deep Security ID assigned to the computer group and applied to the agents on activation. | 1
policy_id | String | ID of the Deep Security Policy to be assigned to the agents. | 1
policy_name | String | Name of the Deep Security Policy to be assigned to the agents. <br /> **Will be ignored if policy_id has been set.** | Base Policy
tenant_id | String | In a multi-tenant installation (like Deep Security as a Service), this identifies the tenant account to register the agent with. <br /> **Multi-tenancy only** | 111A111A-1A1A-11AA-AAA-11AA11111111
token/tenant_password | String | In a multi-tenant installation (like Deep Security as a Service), this identifies the tenant account to register the agent with. In latest Deep Security Manager, "tenant_password" has been replaced with "token". "tenant_password" has been kept for backwards compatibility.<br /> **Multi-tenancy only** | 111A111A-1A1A-11AA-AAA-11AA11111111
group_id | String | The Deep Security ID assigned to the computer group and applied to the Agents on activation. | 1
policy_id | String | ID of the Deep Security Policy to be assigned to the Agents. | 1
policy_name | String | Name of the Deep Security Policy to be assigned to the Agents. <br /> **Will be ignored if policy_id has been set.** | Base Policy
tenant_id | String | In a multi-tenant installation (like Deep Security as a Service), this identifies the tenant account to register the Agent with. <br /> **Multi-tenancy only** | 111A111A-1A1A-11AA-AAA-11AA11111111
token/tenant_password | String | In a multi-tenant installation (like Deep Security as a Service), this identifies the tenant account to register the Agent with. In latest Deep Security Manager, "tenant_password" has been replaced with "token". "tenant_password" has been kept for backwards compatibility.<br /> **Multi-tenancy only** | 111A111A-1A1A-11AA-AAA-11AA11111111
Expand Down

0 comments on commit 58a3f67

Please sign in to comment.