| external help file | Module Name | online version | schema |
|---|---|---|---|
Jagabata.psm.dll-Help.xml |
Jagabata.psm |
2.0.0 |
Retrieve Credentials.
Find-AnsibleCredential [-CredentialTypeKind <CredentialTypeKind[]>] [-CredentialTypeNamespace <String[]>]
[-Galaxy] [-OrderBy <String[]>] [-Search <String[]>] [-Filter <NameValueCollection>] [-Count <UInt16>]
[-Page <UInt32>] [-All] [<CommonParameters>]
Find-AnsibleCredential [-Type] <ResourceType> [-Id] <UInt64> [-CredentialTypeKind <CredentialTypeKind[]>]
[-CredentialTypeNamespace <String[]>] [-Galaxy] [-OrderBy <String[]>] [-Search <String[]>]
[-Filter <NameValueCollection>] [-Count <UInt16>] [-Page <UInt32>] [-All] [<CommonParameters>]
Find-AnsibleCredential -Resource <IResource> [-CredentialTypeKind <CredentialTypeKind[]>]
[-CredentialTypeNamespace <String[]>] [-Galaxy] [-OrderBy <String[]>] [-Search <String[]>]
[-Filter <NameValueCollection>] [-Count <UInt16>] [-Page <UInt32>] [-All] [<CommonParameters>]
Retrieve the list of Credentials.
Implementation of following API:
/api/v2/credentials//api/v2/organizations/{id}/credentials//api/v2/organizations/{id}/galaxy_credentials//api/v2/users/{id}/credentials//api/v2/teams/{id}/credentials//api/v2/credential_types/{id}/credentials//api/v2/inventory_sources/{id}/credentials//api/v2/inventory_updates/{id}/credentials//api/v2/job_templates/{id}/credentials//api/v2/jobs/{id}/credentials//api/v2/schedules/{id}/credentials//api/v2/workflow_job_template_nodes/{id}/credentials//api/v2/workflow_job_nodes/{id}/credentials/
PS C:\> Find-AnsibleCredentialPS C:\> Find-AnsibleCredential -Type Organization -Id 1Retrieve Credentials associated with the Organization of ID 1.
Id and Type parameters can also be given from the pipeline, likes following:
Get-AnsibleOrganization -Id 1 | Find-AnsibleCredential
PS C:\> Find-AnsibleCredential -Type Organization -Id 1 -GalaxyRetrieve Galaxy Credentials associated with the Organization of ID 1.
Retrieve resources from all pages.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseNumber to retrieve per page.
Type: UInt16
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: 20
Accept pipeline input: False
Accept wildcard characters: FalseFilter with CredentialType's kind field.
This parameter is the same as -Filter credential_type__kind__in=....
Type: CredentialTypeKind[]
Parameter Sets: (All)
Aliases: Kind
Accepted values: ssh, vault, net, scm, cloud, registry, token, insights, external, kubernetes, galaxy, cryptography
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseFilter with kind field.
This parameter is the same as -Filter credential_type__namespace__in=....
Examples.)
ssh, scm, vault, net, awx, openstack, vmware, satellite6, gce, azure_rm,
github_token, gitlab_token, insights, rhv, controller, kubernetes_bearer_token,
registry, galaxy_api_token, gpg_public_key, aim, aws_secretsmanager_credential,
azure_kv, centrify_vault_kv, conjur, hashivault_kv, hashivault_ssh, thycotic_dsv,
thycotic_tss
Note
The kind field of a Credential corresponds to namespace field of a CredentialType.
Type: String[]
Parameter Sets: (All)
Aliases: Namespace
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseFiltering various fields.
For examples:
name__icontains=test: "name" field contains "test" (case-insensitive)."name_ in=test,demo", created _gt=2024-01-01: "name" field is "test" or "demo" and created after 2024-01-01.@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }: "name" field NOT contains "test"
For more details, see about_Jagabata.psm_Filter_parameter.
Type: NameValueCollection
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseOnly affected for an Organization type. Retrieve Galaxy Credentials instead of normal Credentials.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseDatebase ID of the target resource.
Use in conjection with the -Type parameter.
Type: UInt64
Parameter Sets: AssociatedWith
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseRetrieve list in the specified orders.
Use ! prefix to sort in reverse.
Multiple sorting fields are available by separating with a comma(,).
Default value: id (ascending order of ID)
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: ["id"]
Accept pipeline input: False
Accept wildcard characters: FalsePage number.
Type: UInt32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: 1
Accept pipeline input: False
Accept wildcard characters: FalseResource object to which the search target associated with.
The resource is accepted following types:
OrganizationUserTeamCredentialTypeInventorySourceInventoryUpdateJobTemplateJobScheduleWorkflowJobTemplateNodeWorkflowJobNode
Type: IResource
Parameter Sets: PipelineInput
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: FalseSearch words. (case-insensitive)
Target fields: name, description
Multiple words are available by separating with a comma(,).
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseResource type name of the target.
Use in conjection with the -Id parameter.
Type: ResourceType
Parameter Sets: AssociatedWith
Aliases:
Accepted values: Organization, User, Team, CredentialType, InventorySource, InventoryUpdate, JobTemplate, Job, Schedule, WorkflowJobTemplateNode, WorkflowJobNode
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Resource object to which the search target associated with.
See: -Resource parameter.