forked from MicrosoftDocs/azure-docs-cli
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathnode.pycliyml
More file actions
420 lines (420 loc) · 16.6 KB
/
node.pycliyml
File metadata and controls
420 lines (420 loc) · 16.6 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
commandList:
- name: az batch node delete
description: Removes compute nodes from the specified pool.
href: node#delete
- name: az batch node file
description: Manage your Batch compute node files.
href: node/file
isGroup: true
- name: az batch node file delete
description: Deletes the specified file from the compute node.
href: node/file#delete
- name: az batch node file download
description: Download the content of the specified node file.
href: node/file#download
- name: az batch node file list
description: Lists all of the files in task directories on the specified compute node.
href: node/file#list
- name: az batch node file show
description: Gets the properties of the specified compute node file.
href: node/file#show
- name: az batch node list
description: Lists the compute nodes in the specified pool.
href: node#list
- name: az batch node reboot
description: Restarts the specified compute node.
href: node#reboot
- name: az batch node reimage
description: Reinstalls the operating system on the specified compute node.
href: node#reimage
- name: az batch node remote-desktop
description: Retrieve the remote desktop protocol for a Batch compute node.
href: node/remote-desktop
isGroup: true
- name: az batch node remote-desktop download
description: Gets the Remote Desktop Protocol file for the specified compute node.
href: node/remote-desktop#download
- name: az batch node remote-login-settings
description: Retrieve the remote login settings for a Batch compute node.
href: node/remote-login-settings
isGroup: true
- name: az batch node remote-login-settings show
description: Gets the settings required for remote login to a compute node.
href: node/remote-login-settings#show
- name: az batch node scheduling
description: Manage task scheduling for a Batch compute node.
href: node/scheduling
isGroup: true
- name: az batch node scheduling disable
description: Disables task scheduling on the specified compute node.
href: node/scheduling#disable
- name: az batch node scheduling enable
description: Enables task scheduling on the specified compute node.
href: node/scheduling#enable
- name: az batch node show
description: Gets information about the specified compute node.
href: node#show
- name: az batch node user
description: Manage the user accounts of your Batch compute node.
href: node/user
isGroup: true
- name: az batch node user create
description: Add a user account to the specified compute node.
href: node/user#create
- name: az batch node user delete
description: Deletes a user account from the specified compute node.
href: node/user#delete
- name: az batch node user reset
description: Update the properties of a user account on the specified compute node. All updatable properties are replaced with the values specified or reset if unspecified.
href: node/user#reset
htmlId: node
examples: []
source:
remote:
path: src/command_modules/azure-cli-batch/azure/cli/command_modules/batch/_help.py
branch: master
repo: https://github.com/Azure/azure-cli.git
children:
- commandList: []
htmlId: delete
examples: []
parameters:
- name: --pool-id
isRequired: True
summary: The ID of the pool from which you want to remove nodes.
description: ''
- name: --json-file
isRequired: False
summary: A file containing the node remove parameter specification in JSON format. If this parameter is specified, all 'Node Remove Arguments' are ignored.
description: ''
- name: --account-endpoint
isRequired: False
summary: 'Batch service endpoint. Alternatively, set by environment variable: AZURE_BATCH_ENDPOINT.'
description: ''
- name: --account-key
isRequired: False
summary: 'Batch account key. Alternatively, set by environment variable: AZURE_BATCH_ACCESS_KEY.'
description: ''
- name: --account-name
isRequired: False
summary: 'Batch account name. Alternatively, set by environment variable: AZURE_BATCH_ACCOUNT.'
description: ''
- name: --node-deallocation-option
isRequired: False
summary: Determines what to do with a node and its running task(s) after it has been selected for deallocation. The default value is requeue.
description: ''
parameterValueGroup: requeue, retainedData, taskCompletion, terminate
- name: --node-list
isRequired: False
summary: A list containing the ids of the compute nodes to be removed from the specified pool. Space separated values.
description: ''
- name: --resize-timeout
isRequired: False
summary: The timeout for removal of compute nodes to the pool. The default value is 15 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service returns an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). Expected format is an ISO-8601 duration.
description: ''
- name: --if-match
isRequired: False
summary: An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.
description: ''
- name: --if-modified-since
isRequired: False
summary: A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.
description: ''
- name: --if-none-match
isRequired: False
summary: An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.
description: ''
- name: --if-unmodified-since
isRequired: False
summary: A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
description: ''
- name: --debug
isRequired: False
summary: Increase logging verbosity to show all debug logs.
description: ''
- name: --help -h
isRequired: False
summary: Show this help message and exit.
description: ''
- name: --output -o
isRequired: False
summary: Output format.
description: ''
defaultValue: json
parameterValueGroup: json, jsonc, table, tsv
- name: --query
isRequired: False
summary: JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.
description: ''
- name: --verbose
isRequired: False
summary: Increase logging verbosity. Use --debug for full debug logs.
description: ''
source:
remote:
path: src/command_modules/azure-cli-batch/azure/cli/command_modules/batch/_help.py
branch: master
repo: https://github.com/Azure/azure-cli.git
children: []
uid: az_batch_node_delete
name: az batch node delete
description: This operation can only run when the allocation state of the pool is steady. When this operation runs, the allocation state changes from steady to resizing.
summary: Removes compute nodes from the specified pool.
Metadata: {}
- commandList: []
htmlId: list
examples: []
parameters:
- name: --pool-id
isRequired: True
summary: The ID of the pool from which you want to list nodes.
description: ''
- name: --account-endpoint
isRequired: False
summary: 'Batch service endpoint. Alternatively, set by environment variable: AZURE_BATCH_ENDPOINT.'
description: ''
- name: --account-key
isRequired: False
summary: 'Batch account key. Alternatively, set by environment variable: AZURE_BATCH_ACCESS_KEY.'
description: ''
- name: --account-name
isRequired: False
summary: 'Batch account name. Alternatively, set by environment variable: AZURE_BATCH_ACCOUNT.'
description: ''
- name: --filter
isRequired: False
summary: An OData $filter clause..
description: ''
- name: --select
isRequired: False
summary: An OData $select clause.
description: ''
- name: --debug
isRequired: False
summary: Increase logging verbosity to show all debug logs.
description: ''
- name: --help -h
isRequired: False
summary: Show this help message and exit.
description: ''
- name: --output -o
isRequired: False
summary: Output format.
description: ''
defaultValue: json
parameterValueGroup: json, jsonc, table, tsv
- name: --query
isRequired: False
summary: JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.
description: ''
- name: --verbose
isRequired: False
summary: Increase logging verbosity. Use --debug for full debug logs.
description: ''
source:
remote:
path: src/command_modules/azure-cli-batch/azure/cli/command_modules/batch/_help.py
branch: master
repo: https://github.com/Azure/azure-cli.git
children: []
uid: az_batch_node_list
name: az batch node list
description: ''
summary: Lists the compute nodes in the specified pool.
Metadata: {}
- commandList: []
htmlId: reboot
examples: []
parameters:
- name: --node-id
isRequired: True
summary: The ID of the compute node that you want to restart.
description: ''
- name: --pool-id
isRequired: True
summary: The ID of the pool that contains the compute node.
description: ''
- name: --node-reboot-option
isRequired: False
summary: When to reboot the compute node and what to do with currently running tasks. The default value is requeue.
description: ''
parameterValueGroup: '''requeue'', ''retainedData'', ''taskCompletion'', ''terminate'''
- name: --account-endpoint
isRequired: False
summary: 'Batch service endpoint. Alternatively, set by environment variable: AZURE_BATCH_ENDPOINT.'
description: ''
- name: --account-key
isRequired: False
summary: 'Batch account key. Alternatively, set by environment variable: AZURE_BATCH_ACCESS_KEY.'
description: ''
- name: --account-name
isRequired: False
summary: 'Batch account name. Alternatively, set by environment variable: AZURE_BATCH_ACCOUNT.'
description: ''
- name: --debug
isRequired: False
summary: Increase logging verbosity to show all debug logs.
description: ''
- name: --help -h
isRequired: False
summary: Show this help message and exit.
description: ''
- name: --output -o
isRequired: False
summary: Output format.
description: ''
defaultValue: json
parameterValueGroup: json, jsonc, table, tsv
- name: --query
isRequired: False
summary: JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.
description: ''
- name: --verbose
isRequired: False
summary: Increase logging verbosity. Use --debug for full debug logs.
description: ''
source:
remote:
path: src/command_modules/azure-cli-batch/azure/cli/command_modules/batch/_help.py
branch: master
repo: https://github.com/Azure/azure-cli.git
children: []
uid: az_batch_node_reboot
name: az batch node reboot
description: You can restart a node only if it is in an idle or running state.
summary: Restarts the specified compute node.
Metadata: {}
- commandList: []
htmlId: reimage
examples: []
parameters:
- name: --node-id
isRequired: True
summary: The ID of the compute node that you want to restart.
description: ''
- name: --pool-id
isRequired: True
summary: The ID of the pool that contains the compute node.
description: ''
- name: --node-reimage-option
isRequired: False
summary: When to reimage the compute node and what to do with currently running tasks. The default value is requeue.
description: ''
parameterValueGroup: '''requeue'', ''retainedData'', ''taskCompletion'', ''terminate'''
- name: --account-endpoint
isRequired: False
summary: 'Batch service endpoint. Alternatively, set by environment variable: AZURE_BATCH_ENDPOINT.'
description: ''
- name: --account-key
isRequired: False
summary: 'Batch account key. Alternatively, set by environment variable: AZURE_BATCH_ACCESS_KEY.'
description: ''
- name: --account-name
isRequired: False
summary: 'Batch account name. Alternatively, set by environment variable: AZURE_BATCH_ACCOUNT.'
description: ''
- name: --debug
isRequired: False
summary: Increase logging verbosity to show all debug logs.
description: ''
- name: --help -h
isRequired: False
summary: Show this help message and exit.
description: ''
- name: --output -o
isRequired: False
summary: Output format.
description: ''
defaultValue: json
parameterValueGroup: json, jsonc, table, tsv
- name: --query
isRequired: False
summary: JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.
description: ''
- name: --verbose
isRequired: False
summary: Increase logging verbosity. Use --debug for full debug logs.
description: ''
source:
remote:
path: src/command_modules/azure-cli-batch/azure/cli/command_modules/batch/_help.py
branch: master
repo: https://github.com/Azure/azure-cli.git
children: []
uid: az_batch_node_reimage
name: az batch node reimage
description: You can reinstall the operating system on a node only if it is in an idle or running state. This API can be invoked only on pools created with the cloud service configuration property.
summary: Reinstalls the operating system on the specified compute node.
Metadata: {}
- commandList: []
htmlId: show
examples: []
parameters:
- name: --node-id
isRequired: True
summary: The ID of the compute node that you want to get information about.
description: ''
- name: --pool-id
isRequired: True
summary: The ID of the pool that contains the compute node.
description: ''
- name: --account-endpoint
isRequired: False
summary: 'Batch service endpoint. Alternatively, set by environment variable: AZURE_BATCH_ENDPOINT.'
description: ''
- name: --account-key
isRequired: False
summary: 'Batch account key. Alternatively, set by environment variable: AZURE_BATCH_ACCESS_KEY.'
description: ''
- name: --account-name
isRequired: False
summary: 'Batch account name. Alternatively, set by environment variable: AZURE_BATCH_ACCOUNT.'
description: ''
- name: --select
isRequired: False
summary: An OData $select clause.
description: ''
- name: --debug
isRequired: False
summary: Increase logging verbosity to show all debug logs.
description: ''
- name: --help -h
isRequired: False
summary: Show this help message and exit.
description: ''
- name: --output -o
isRequired: False
summary: Output format.
description: ''
defaultValue: json
parameterValueGroup: json, jsonc, table, tsv
- name: --query
isRequired: False
summary: JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.
description: ''
- name: --verbose
isRequired: False
summary: Increase logging verbosity. Use --debug for full debug logs.
description: ''
source:
remote:
path: src/command_modules/azure-cli-batch/azure/cli/command_modules/batch/_help.py
branch: master
repo: https://github.com/Azure/azure-cli.git
children: []
uid: az_batch_node_show
name: az batch node show
description: ''
summary: Gets information about the specified compute node.
Metadata: {}
uid: az_batch_node
name: 'Batch compute nodes - az batch node'
description: ''
summary: Manage your Batch compute nodes.
Metadata:
doc_source_url_repo: https://github.com/Azure/azure-cli/blob/master/
doc_source_url_path: src/command_modules/azure-cli-batch/azure/cli/command_modules/batch/_help.py
original_content_git_url: https://github.com/Azure/azure-cli/blob/master/src/command_modules/azure-cli-batch/azure/cli/command_modules/batch/_help.py
gitcommit: https://github.com/Azure/azure-cli/blob/71c76c65a64e7dd4788a51d85644b01012f80356/src/command_modules/azure-cli-batch/azure/cli/command_modules/batch/_help.py
updated_at: 6/8/2017 4:07:47 PM
ms.date: 6/8/2017