You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+20-20Lines changed: 20 additions & 20 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,60 +1,60 @@
1
-
# AppDynamics Commandline Tool (ADC)
1
+
# API Commandline Tool
2
2
3
-
The AppDynamics Commandline Tool (ADC) is a shell script wrapper around [API](https://docs.appdynamics.com/display/PRO43/AppDynamics+APIs#AppDynamicsAPIs-apiindex) calls towards an AppDynamics controller.
3
+
The API Commandline Tool (ACT) is a shell script wrapper around [API](https://docs.appdynamics.com/display/latest/AppDynamics+APIs#AppDynamicsAPIs-apiindex) calls towards an AppDynamics controller.
4
4
5
5
## Installation
6
6
7
-
To use the latest release of ADC just download the raw version of [adc.sh](https://github.com/Appdynamics/adc/blob/master/adc.sh)
7
+
To use the latest release of ACT just download the raw version of [act.sh](https://github.com/Appdynamics/api-commandline-tool/blob/master/act.sh)
8
8
9
-
Afterwards run `adc.sh config` to provide your controller host and credentials. This will create a configuration file at `~/.appdynamics/adc/config.sh`, e.g.:
9
+
Afterwards run `act.sh config` to provide your controller host and credentials. This will create a configuration file at `~/.appdynamics/act/config.sh`, e.g.:
If you want to change your configuration, you can either edit this file or you can re-run the self setup:
18
18
19
19
```
20
-
adc.sh config -f
20
+
act.sh config -f
21
21
```
22
22
23
23
## Usage
24
24
25
-
`adc.sh` integrates different commands to interact with your AppDynamics controller. Call `adc.sh help` to get a full list of commands.
25
+
`act.sh` integrates different commands to interact with your AppDynamics controller. Call `act.sh help` to get a full list of commands.
26
26
27
27
A simple work flow example is listing, exporting and deleting a dashboard:
28
28
29
29
```
30
-
adc.sh dashboard list
31
-
adc.sh dashboard export 13
32
-
adc.sh dashboard delete 13
30
+
act.sh dashboard list
31
+
act.sh dashboard export 13
32
+
act.sh dashboard delete 13
33
33
```
34
34
35
-
Another example is getting a notification while your on premise controller is starting up. Combine adc.sh with the notification tool of your choice ([noti](https://github.com/variadico/noti/), [terminal-notifier](https://github.com/julienXX/terminal-notifier), ...) or run commands after the controller is running:
35
+
Another example is getting a notification while your on premise controller is starting up. Combine act.sh with the notification tool of your choice ([noti](https://github.com/variadico/noti/), [terminal-notifier](https://github.com/julienXX/terminal-notifier), ...) or run commands after the controller is running:
36
36
37
37
```
38
-
noti adc.sh controller isup
39
-
adc.sh controller isup | terminal-notifier
40
-
adc.sh controller isup ; adc.sh applications list
38
+
noti act.sh controller isup
39
+
act.sh controller isup | terminal-notifier
40
+
act.sh controller isup ; act.sh applications list
41
41
```
42
42
43
-
Also, you can use `adc.sh` to easily create custom events, like code deployments:
43
+
Also, you can use `act.sh` to easily create custom events, like code deployments:
44
44
45
45
```
46
-
adc.sh event create -s INFO -c "This release fixes some minor issues with the mini cart functionality" -e APPLICATION_DEPLOYMENT -a 145 "Version 3.5.1 released"
46
+
act.sh event create -s INFO -c "This release fixes some minor issues with the mini cart functionality" -e APPLICATION_DEPLOYMENT -a 145 "Version 3.5.1 released"
47
47
```
48
48
49
49
If a certain API call is not yet wrapped into a command, you can use `controller call` as general interface:
If you want to use custom plugins with `adc.sh` you can place shell scripts into a plugin folder (default: `~/.appdynamics/adc/plugins`) and they will be sourced automatically. A command plugin requires the following structure:
57
+
If you want to use custom plugins with `act.sh` you can place shell scripts into a plugin folder (default: `~/.appdynamics/act/plugins`) and they will be sourced automatically. A command plugin requires the following structure:
58
58
59
59
```
60
60
#!/bin/bash
@@ -72,15 +72,15 @@ function tier_nodes {
72
72
}
73
73
```
74
74
75
-
The command `adc.sh tier nodes` will now take two arguments (via -a and -t) and send the given request to the AppDynamics controller.
75
+
The command `act.sh tier nodes` will now take two arguments (via -a and -t) and send the given request to the AppDynamics controller.
76
76
77
77
Since all other sub commands are loaded, you can reuse them in your plugin. Most importantly `call_controller` to send requests to the controller.
78
78
79
79
Please note, that your plugins will not be validated, so you can change global behaviour or break the script.
80
80
81
81
## Build
82
82
83
-
To make working on `adc.sh` easier this git repository includes a very simple build system: The file `main.sh` is merged with all scripts in the sub directories, that are `source`d. So, if you want to build a custom version of `adc.sh` clone this directory, edit `main.sh` or any of the other files in this repository and run `build.sh` to update the script. Any changes you made directly to `adc.sh` will be overwritten.
83
+
To make working on `act.sh` easier this git repository includes a very simple build system: The file `main.sh` is merged with all scripts in the sub directories, that are `source`d. So, if you want to build a custom version of `act.sh` clone this directory, edit `main.sh` or any of the other files in this repository and run `build.sh` to update the script. Any changes you made directly to `act.sh` will be overwritten.
0 commit comments