Reference documentation and code samples for the Google Cloud Hypercompute Cluster V1beta Client class SlurmLoginNodes.
Configuration for Slurm login nodes in the cluster.
Login nodes are Compute Engine VM instances that allow users to access the cluster over SSH.
Generated from protobuf message google.cloud.hypercomputecluster.v1beta.SlurmLoginNodes
Namespace
Google \ Cloud \ HypercomputeCluster \ V1betaMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ count |
int|string
Required. Number of login node instances to create. |
↳ zone |
string
Required. Name of the zone in which login nodes should run, e.g., |
↳ machine_type |
string
Required. Name of the Compute Engine machine type to use for login nodes, e.g. |
↳ startup_script |
string
Optional. Startup script to be run on each login node instance. Max 256KB. |
↳ enable_os_login |
bool
Optional. Whether OS Login should be enabled on login node instances. |
↳ enable_public_ips |
bool
Optional. Whether login node instances should be assigned external IP addresses. |
↳ labels |
array|Google\Protobuf\Internal\MapField
Optional. Labels that should be applied to each login node instance. |
↳ storage_configs |
array<StorageConfig>
Optional. How storage resources should be mounted on each login node. |
↳ instances |
array<ComputeInstance>
Output only. Information about the login node instances that were created in Compute Engine. |
↳ boot_disk |
BootDisk
Optional. Boot disk for the login node. |
getCount
Required. Number of login node instances to create.
| Returns | |
|---|---|
| Type | Description |
int|string |
|
setCount
Required. Number of login node instances to create.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getZone
Required. Name of the zone in which login nodes should run, e.g.,
us-central1-a. Must be in the same region as the cluster, and must match
the zone of any other resources specified in the cluster.
| Returns | |
|---|---|
| Type | Description |
string |
|
setZone
Required. Name of the zone in which login nodes should run, e.g.,
us-central1-a. Must be in the same region as the cluster, and must match
the zone of any other resources specified in the cluster.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMachineType
Required. Name of the Compute Engine machine
type to use for
login nodes, e.g. n2-standard-2.
| Returns | |
|---|---|
| Type | Description |
string |
|
setMachineType
Required. Name of the Compute Engine machine
type to use for
login nodes, e.g. n2-standard-2.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getStartupScript
Optional. Startup script to be run on each login node instance. Max 256KB.
| Returns | |
|---|---|
| Type | Description |
string |
|
setStartupScript
Optional. Startup script to be run on each login node instance. Max 256KB.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEnableOsLogin
Optional. Whether OS Login should be enabled on login node instances.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setEnableOsLogin
Optional. Whether OS Login should be enabled on login node instances.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEnablePublicIps
Optional. Whether login node instances should be assigned external IP addresses.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setEnablePublicIps
Optional. Whether login node instances should be assigned external IP addresses.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLabels
Optional.
Labels that should be applied to each login node instance.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField |
|
setLabels
Optional.
Labels that should be applied to each login node instance.
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getStorageConfigs
Optional. How storage resources should be mounted on each login node.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setStorageConfigs
Optional. How storage resources should be mounted on each login node.
| Parameter | |
|---|---|
| Name | Description |
var |
array<StorageConfig>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getInstances
Output only. Information about the login node instances that were created in Compute Engine.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setInstances
Output only. Information about the login node instances that were created in Compute Engine.
| Parameter | |
|---|---|
| Name | Description |
var |
array<ComputeInstance>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getBootDisk
Optional. Boot disk for the login node.
| Returns | |
|---|---|
| Type | Description |
BootDisk|null |
|
hasBootDisk
clearBootDisk
setBootDisk
Optional. Boot disk for the login node.
| Parameter | |
|---|---|
| Name | Description |
var |
BootDisk
|
| Returns | |
|---|---|
| Type | Description |
$this |
|