github.com/vmware/govmomi@v0.43.0/govc/pool/help.go (about)

     1  /*
     2  Copyright (c) 2015 VMware, Inc. All Rights Reserved.
     3  
     4  Licensed under the Apache License, Version 2.0 (the "License");
     5  you may not use this file except in compliance with the License.
     6  You may obtain a copy of the License at
     7  
     8      http://www.apache.org/licenses/LICENSE-2.0
     9  
    10  Unless required by applicable law or agreed to in writing, software
    11  distributed under the License is distributed on an "AS IS" BASIS,
    12  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    13  See the License for the specific language governing permissions and
    14  limitations under the License.
    15  */
    16  
    17  package pool
    18  
    19  var poolNameHelp = `
    20  POOL may be an absolute or relative path to a resource pool or a (clustered)
    21  compute host. If it resolves to a compute host, the associated root resource
    22  pool is returned. If a relative path is specified, it is resolved with respect
    23  to the current datacenter's "host" folder (i.e. /ha-datacenter/host).
    24  
    25  Paths to nested resource pools must traverse through the root resource pool of
    26  the selected compute host, i.e. "compute-host/Resources/nested-pool".
    27  
    28  The same globbing rules that apply to the "ls" command apply here. For example,
    29  POOL may be specified as "*/Resources/*" to expand to all resource pools that
    30  are nested one level under the root resource pool, on all (clustered) compute
    31  hosts in the current datacenter.`
    32  
    33  var poolCreateHelp = `
    34  POOL may be an absolute or relative path to a resource pool. The parent of the
    35  specified POOL must be an existing resource pool. If a relative path is
    36  specified, it is resolved with respect to the current datacenter's "host"
    37  folder (i.e. /ha-datacenter/host). The basename of the specified POOL is used
    38  as the name for the new resource pool.
    39  
    40  The same globbing rules that apply to the "ls" command apply here. For example,
    41  the path to the parent resource pool in POOL may be specified as "*/Resources"
    42  to expand to the root resource pools on all (clustered) compute hosts in the
    43  current datacenter.
    44  
    45  For example:
    46    */Resources/test             Create resource pool "test" on all (clustered)
    47                                 compute hosts in the current datacenter.
    48    somehost/Resources/*/nested  Create resource pool "nested" in every
    49                                 resource pool that is a direct descendant of
    50                                 the root resource pool on "somehost".`