33All interactions with the [ ` v1/agent ` ] ( https://www.consul.io/docs/agent/http/agent.html ) endpoint are done
44via the [ AgentClient] ( ../src/Agent/AgentClient.php ) class.
55
6- If you have constructed a [ Client ] ( ../src/Client .php ) object, this is done as so:
6+ If you have constructed a [ Consul ] ( ../src/Consul .php ) object, this is done as so:
77
88``` php
9- $agent = $client ->Agent;
9+ $agent = $consul ->Agent;
1010```
1111
1212## Actions
1313
1414### Get "Self"
1515
1616``` php
17- list($self, $qm, $err) = $client ->Agent->self();
17+ list($self, $qm, $err) = $consul ->Agent->self();
1818if (null !== $err)
1919 die($err);
2020
@@ -24,7 +24,7 @@ var_dump($qm, $self);
2424### Get Name of Node
2525
2626``` php
27- list($nodeName, $err) = $client ->Agent->nodeName();
27+ list($nodeName, $err) = $consul ->Agent->nodeName();
2828if (null !== $err)
2929 die($err);
3030
@@ -34,7 +34,7 @@ var_dump($nodeName);
3434### Get List of Agent Checks
3535
3636``` php
37- list($checks, $err) = $client ->Agent->checks();
37+ list($checks, $err) = $consul ->Agent->checks();
3838if (null !== $err)
3939 die($err);
4040
@@ -44,7 +44,7 @@ var_dump($checks);
4444### Get List of Agent Services
4545
4646``` php
47- list($services, $err) = $client ->Agent->services();
47+ list($services, $err) = $consul ->Agent->services();
4848if (null !== $err)
4949 die($err);
5050
@@ -54,7 +54,7 @@ var_dump($services);
5454### Get List of Cluster Members
5555
5656``` php
57- list($members, $err) = $client ->Agent->members();
57+ list($members, $err) = $consul ->Agent->members();
5858if (null !== $err)
5959 die($err);
6060
@@ -79,15 +79,15 @@ $service = new \DCarbone\PHPConsulAPI\Agent\AgentServiceRegistration(
7979 )
8080);
8181
82- $err = $client ->Agent->serviceRegister($service);
82+ $err = $consul ->Agent->serviceRegister($service);
8383if (null !== $err)
8484 die($err);
8585```
8686
8787### Deregister Service
8888
8989``` php
90- $err = $client ->Agent->serviceDeregister('dan test service');
90+ $err = $consul ->Agent->serviceDeregister('dan test service');
9191if (null !== $err)
9292 die($err);
9393```
@@ -107,87 +107,87 @@ $check = new \DCarbone\PHPConsulAPI\Agent\AgentCheckRegistration(
107107 )
108108);
109109
110- $err = $client ->Agent->checkRegister($check);
110+ $err = $consul ->Agent->checkRegister($check);
111111if (null !== $err)
112112 die($err);
113113```
114114
115115### Deregister Agent Check
116116
117117``` php
118- $err = $client ->Agent()->checkDeregister('dan test service check');
118+ $err = $consul ->Agent()->checkDeregister('dan test service check');
119119if (null !== $err)
120120 die($err);
121121```
122122
123123### Join
124124
125125``` php
126- $err = $client ->Agent->join('address to join');
126+ $err = $consul ->Agent->join('address to join');
127127if (null !== $err)
128128 die($err);
129129```
130130
131131### Force Leave
132132
133133``` php
134- $err = $client ->Agent->forceLeave('node name');
134+ $err = $consul ->Agent->forceLeave('node name');
135135if (null !== $err)
136136 die($err);
137137```
138138
139139### Enable Service Maintenance
140140
141141``` php
142- $err = $client ->Agent->enableServiceMaintenance('service id', 'because reasons');
142+ $err = $consul ->Agent->enableServiceMaintenance('service id', 'because reasons');
143143if (null !== $err)
144144 die($err);
145145```
146146
147147### Disable Service Maintenance
148148
149149``` php
150- $err = $client ->Agent->disableServiceMaintenance('service id');
150+ $err = $consul ->Agent->disableServiceMaintenance('service id');
151151if (null !== $er)
152152 die($err);
153153```
154154
155155### Enable Node Maintenance
156156
157157``` php
158- $err = $client ->Agent->enableNodeMaintenance('because GOOD reasons');
158+ $err = $consul ->Agent->enableNodeMaintenance('because GOOD reasons');
159159if (null !== $err)
160160 die($err);
161161```
162162
163163### Disable Node Maintenance
164164
165165``` php
166- $err = $client ->Agent->disableNodeMaintenance();
166+ $err = $consul ->Agent->disableNodeMaintenance();
167167if (null !== $err)
168168 die($err);
169169```
170170
171171### Set TTL Check to Passing
172172
173173``` php
174- $err = $client ->Agent->passTTL('check id', 'all good here, dudes');
174+ $err = $consul ->Agent->passTTL('check id', 'all good here, dudes');
175175if (null !== $err)
176176 die($err);
177177```
178178
179179### Set TTL Check to Warning
180180
181181``` php
182- $err = $client ->Agent->warnTTL('check id', 'might not be good here, dudes');
182+ $err = $consul ->Agent->warnTTL('check id', 'might not be good here, dudes');
183183if (null !== $err)
184184 die($err);
185185```
186186
187187### Set TTL Check to Failing
188188
189189``` php
190- $err = $client ->Agent->failTTL('check id', 'super not good here, dudes.');
190+ $err = $consul ->Agent->failTTL('check id', 'super not good here, dudes.');
191191if (null !== $err)
192192 die($err);
193193```
0 commit comments