Skip to content

Latest commit

 

History

History
631 lines (472 loc) · 19 KB

Set-IntersightKubernetesClusterProfile.md

File metadata and controls

631 lines (472 loc) · 19 KB
external help file Module Name online version schema
Intersight.PowerShell.dll-Help.xml
Intersight.PowerShell
2.0.0

Set-IntersightKubernetesClusterProfile

SYNOPSIS

Fill in the Synopsis

SYNTAX


Set-IntersightKubernetesClusterProfile [-Action< string>][-ActionParams< System.Collections.Generic.List`1[PolicyActionParam]>][-AdditionalProperties< System.Collections.Generic.Dictionary`2[string,object]>][-CertConfig< KubernetesClusterCertificateConfiguration>][-ClusterIpPools< System.Collections.Generic.List`1[IppoolPoolRelationship]>][-ConfigContext< PolicyConfigContext>][-ContainerRuntimeConfig< KubernetesContainerRuntimePolicyRelationship>][-ContainerRuntimeProxyPolicy< KubernetesHttpProxyPolicyRelationship>][-Description< string>][-DeviceConnectorProxyPolicy< KubernetesHttpProxyPolicyRelationship>][-EssentialAddons< System.Collections.Generic.List`1[KubernetesEssentialAddon]>][-KubeConfig< KubernetesConfiguration>][-LoadbalancerBlockIpLeases< System.Collections.Generic.List`1[IppoolBlockLeaseRelationship]>][-LoadbalancerIpLeases< System.Collections.Generic.List`1[IppoolIpLeaseRelationship]>][-ManagedMode< KubernetesClusterProfile.ManagedModeEnum>][-ManagementConfig< KubernetesClusterManagementConfig>][-MasterVipLease< IppoolIpLeaseRelationship>][[-Moid]< string>][-Name< string>][-NetConfig< KubernetesNetworkPolicyRelationship>][-NodeGroups< System.Collections.Generic.List`1[KubernetesNodeGroupProfileRelationship]>][-Organization< OrganizationOrganizationRelationship>][-ParentSolutionProfile< MoBaseMoRelationship>][-PolicyBucket< System.Collections.Generic.List`1[PolicyAbstractPolicyRelationship]>][-ScheduledActions< System.Collections.Generic.List`1[PolicyScheduledAction]>][-SrcTemplate< PolicyAbstractProfileRelationship>][-Status< KubernetesClusterProfile.StatusEnum>][-SysConfig< KubernetesSysConfigPolicyRelationship>][-Tags< System.Collections.Generic.List`1[MoTag]>][-TrustedRegistries< KubernetesTrustedRegistriesPolicyRelationship>][-Type< KubernetesClusterProfile.TypeEnum>][-Json< SwitchParameter>][-WithHttpInfo< SwitchParameter>]

DESCRIPTION

Update a 'KubernetesClusterProfile' resource.

PARAMETERS

-Action

User initiated action. Each profile type has its own supported actions. For HyperFlex cluster profile, the supported actions are -- Validate, Deploy, Continue, Retry, Abort, Unassign For server profile, the support actions are -- Deploy, Unassign.

Type: string
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-ActionParams

Note :- Use Initialize-IntersightPolicyActionParam to create the object of complex type PolicyActionParam

Type: System.Collections.Generic.List`1[PolicyActionParam]
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-AdditionalProperties

Type: System.Collections.Generic.Dictionary`2[string,object]
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-CertConfig

Certificates and keys that are used to configure a Kubernetes\ncluster. If user does not specify any Certificates or Keys,\nsystem generated certificates will be used to configure the cluster.

Note :- Use Initialize-IntersightKubernetesClusterCertificateConfiguration to create the object of complex type KubernetesClusterCertificateConfiguration

Type: KubernetesClusterCertificateConfiguration
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-ClusterIpPools

An array of relationships to ippoolPool resources.

Note:- To get the relationship object pass the MO to the cmdlet Get-IntersightMoMoRef or use the cmdlet Initialize-IntersightMoMoRef.

Type: System.Collections.Generic.List`1[IppoolPoolRelationship]
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-ConfigContext

The configuration state and results of the last configuration operation.

Note :- Use Initialize-IntersightPolicyConfigContext to create the object of complex type PolicyConfigContext

Type: PolicyConfigContext
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-ContainerRuntimeConfig

A reference to a kubernetesContainerRuntimePolicy resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.

Note:- To get the relationship object pass the MO to the cmdlet Get-IntersightMoMoRef or use the cmdlet Initialize-IntersightMoMoRef.

Type: KubernetesContainerRuntimePolicyRelationship
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-ContainerRuntimeProxyPolicy

A reference to a kubernetesHttpProxyPolicy resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.

Note:- To get the relationship object pass the MO to the cmdlet Get-IntersightMoMoRef or use the cmdlet Initialize-IntersightMoMoRef.

Type: KubernetesHttpProxyPolicyRelationship
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-Description

Description of the profile.

Type: string
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-DeviceConnectorProxyPolicy

A reference to a kubernetesHttpProxyPolicy resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.

Note:- To get the relationship object pass the MO to the cmdlet Get-IntersightMoMoRef or use the cmdlet Initialize-IntersightMoMoRef.

Type: KubernetesHttpProxyPolicyRelationship
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-EssentialAddons

Note :- Use Initialize-IntersightKubernetesEssentialAddon to create the object of complex type KubernetesEssentialAddon

Type: System.Collections.Generic.List`1[KubernetesEssentialAddon]
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-KubeConfig

Certificates and keys that are used to access a Kubernetes\ncluster.

Note :- Use Initialize-IntersightKubernetesConfiguration to create the object of complex type KubernetesConfiguration

Type: KubernetesConfiguration
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-LoadbalancerBlockIpLeases

An array of relationships to ippoolBlockLease resources.

Note:- To get the relationship object pass the MO to the cmdlet Get-IntersightMoMoRef or use the cmdlet Initialize-IntersightMoMoRef.

Type: System.Collections.Generic.List`1[IppoolBlockLeaseRelationship]
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-LoadbalancerIpLeases

An array of relationships to ippoolIpLease resources.

Note:- To get the relationship object pass the MO to the cmdlet Get-IntersightMoMoRef or use the cmdlet Initialize-IntersightMoMoRef.

Type: System.Collections.Generic.List`1[IppoolIpLeaseRelationship]
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-ManagedMode

Management mode for the cluster. In some cases Intersight kubernetes service is not required\nto provision and manage the management entities and endpoints (for e.g. EKS). In most other cases\nit will be required to provision and manage these entities and endpoints.\n* Provided - Cluster management entities and endpoints are provided by the infrastructure platform.\n* Managed - Cluster management entities and endpoints are provisioned and managed by Intersight kubernetes service.

Type: KubernetesClusterProfile.ManagedModeEnum
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-ManagementConfig

Configuration required for provisioning and management of cluster management entities. Required if\n'managedMode' is set to 'Managed'.

Note :- Use Initialize-IntersightKubernetesClusterManagementConfig to create the object of complex type KubernetesClusterManagementConfig

Type: KubernetesClusterManagementConfig
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-MasterVipLease

A reference to a ippoolIpLease resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.

Note:- To get the relationship object pass the MO to the cmdlet Get-IntersightMoMoRef or use the cmdlet Initialize-IntersightMoMoRef.

Type: IppoolIpLeaseRelationship
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-Moid

The unique identifier of this Managed Object instance.

Type: string
Parameter Sets: (All)
Aliases:

Required: true
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-Name

Name of the profile instance or profile template.

Type: string
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-NetConfig

A reference to a kubernetesNetworkPolicy resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.

Note:- To get the relationship object pass the MO to the cmdlet Get-IntersightMoMoRef or use the cmdlet Initialize-IntersightMoMoRef.

Type: KubernetesNetworkPolicyRelationship
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-NodeGroups

An array of relationships to kubernetesNodeGroupProfile resources.

Note:- To get the relationship object pass the MO to the cmdlet Get-IntersightMoMoRef or use the cmdlet Initialize-IntersightMoMoRef.

Type: System.Collections.Generic.List`1[KubernetesNodeGroupProfileRelationship]
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-Organization

A reference to a organizationOrganization resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.

Note:- To get the relationship object pass the MO to the cmdlet Get-IntersightMoMoRef or use the cmdlet Initialize-IntersightMoMoRef.

Type: OrganizationOrganizationRelationship
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-ParentSolutionProfile

A reference to a moBaseMo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.

Note:- To get the relationship object pass the MO to the cmdlet Get-IntersightMoMoRef or use the cmdlet Initialize-IntersightMoMoRef.

Type: MoBaseMoRelationship
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-PolicyBucket

An array of relationships to policyAbstractPolicy resources.

Note:- To get the relationship object pass the MO to the cmdlet Get-IntersightMoMoRef or use the cmdlet Initialize-IntersightMoMoRef.

Type: System.Collections.Generic.List`1[PolicyAbstractPolicyRelationship]
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-ScheduledActions

Note :- Use Initialize-IntersightPolicyScheduledAction to create the object of complex type PolicyScheduledAction

Type: System.Collections.Generic.List`1[PolicyScheduledAction]
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-SrcTemplate

A reference to a policyAbstractProfile resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.

Note:- To get the relationship object pass the MO to the cmdlet Get-IntersightMoMoRef or use the cmdlet Initialize-IntersightMoMoRef.

Type: PolicyAbstractProfileRelationship
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-Status

Status of the Kubernetes cluster and its nodes.\n* Undeployed - The cluster is undeployed.\n* Configuring - The cluster is being configured.\n* Deploying - The cluster is being deployed.\n* Undeploying - The cluster is being undeployed.\n* DeployFailedTerminal - The Cluster Deploy failed creation and can not be recovered, only Delete or Undeploy operations are available for this Cluster.\n* DeployFailed - The cluster deployment failed.\n* Upgrading - The cluster is being upgraded.\n* Deleting - The cluster is being deleted.\n* DeleteFailed - The Cluster Delete failed and the Cluster can not be recovered, only Delete or Undeploy operations are available for this Cluster.\n* Ready - The cluster is ready for use.\n* Active - The cluster is being active.\n* Shutdown - All the nodes in the cluster are powered off.\n* Terminated - The cluster is terminated.\n* Deployed - The cluster is deployed. The cluster may not yet be ready for use.\n* UndeployFailed - The cluster undeploy action failed.\n* NotReady - The cluster is created and some nodes are not ready.

Type: KubernetesClusterProfile.StatusEnum
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-SysConfig

A reference to a kubernetesSysConfigPolicy resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.

Note:- To get the relationship object pass the MO to the cmdlet Get-IntersightMoMoRef or use the cmdlet Initialize-IntersightMoMoRef.

Type: KubernetesSysConfigPolicyRelationship
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-Tags

Note :- Use Initialize-IntersightMoTag to create the object of complex type MoTag

Type: System.Collections.Generic.List`1[MoTag]
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-TrustedRegistries

A reference to a kubernetesTrustedRegistriesPolicy resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.

Note:- To get the relationship object pass the MO to the cmdlet Get-IntersightMoMoRef or use the cmdlet Initialize-IntersightMoMoRef.

Type: KubernetesTrustedRegistriesPolicyRelationship
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-Type

Defines the type of the profile. Accepted values are instance or template.\n* instance - The profile defines the configuration for a specific instance of a target.

Type: KubernetesClusterProfile.TypeEnum
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-Json

Returns the json payload received in response.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True False
Accept wildcard characters: False

-WithHttpInfo

Returns the HTTP response with headers and content.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

EXAMPLES

Example 1

PS C:\> Set-IntersightKubernetesClusterProfile

{ Add example description here }

INPUTS

System.Int32

System.String

OUTPUTS

TestModule.FavoriteStuff

NOTES

RELATED LINKS

Get-IntersightKubernetesClusterProfile

Initialize-IntersightKubernetesActionInfo

Initialize-IntersightKubernetesClusterCertificateConfiguration

Initialize-IntersightKubernetesClusterManagementConfig

Initialize-IntersightKubernetesConfiguration

Initialize-IntersightKubernetesEssentialAddon

Initialize-IntersightMoVersionContext

Initialize-IntersightPolicyActionParam

Initialize-IntersightPolicyConfigContext

Initialize-IntersightPolicyScheduledAction

New-IntersightKubernetesClusterProfile

Remove-IntersightKubernetesClusterProfile