psWeblogic

Description
DotNetFrameworkVersion
ModuleVersion
Author
ProjectUri
Copyright

Provides specific weblogic tasks from PowerShell.
4.0
0.0.0.5
Leonardo Rizzi
https://github.com/leorzz/psWeblogic
The MIT License (MIT) Copyright (c) 2013 Leonardo Rizzi Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Get-WLCacheIndex

Synopsis

Show current cache index.

Syntax

Get-WLCacheIndex

Description

Parameters

Inputs

Outputs

Examples

Example 1

Get-WLCacheIndex | Format-Table

Output

   Uri                                                                        ValidTo             FullName                                  
---                                                                        -------             --------                                  
https://wls-infra.local.com:443/management/wls/latest/servers     02/03/2016 10:03:54 C:\Users\user01\AppData\Local\Temp\w...
https://wls-infra.local.com:443/management/wls/latest/datasources 02/03/2016 10:04:12 C:\Users\user01\AppData\Local\Temp\w...

Notes

Get-WLChangeManager

Synopsis

Get information about Managing Configuration Changes

Syntax

Get-WLChangeManager [-AdminServer <List`1[String]>] [-Credential <PSCredential>] [-SecureConnection <SwitchParameter>] [-Cache <SwitchParameter>] [-TimeoutSec <Int32>] [-WhatIf <SwitchParameter>] [-Confirm <SwitchParameter>]

Get-WLChangeManager [-InputObject <PSObject>] [-AdminServer <List`1[String]>] [-Credential <PSCredential>] [-SecureConnection <SwitchParameter>] [-Cache <SwitchParameter>] [-TimeoutSec <Int32>] [-WhatIf <SwitchParameter>] [-Confirm <SwitchParameter>]

Get-WLChangeManager [-AdminServer <List`1[String]>] [-Credential <PSCredential>] [-SecureConnection <SwitchParameter>] [-Cache <SwitchParameter>] [-TimeoutSec <Int32>] [-WhatIf <SwitchParameter>] [-Confirm <SwitchParameter>]

Description

Parameters

-AdminServer: <List`1[String]>
Determine the AdminServer target. Suggestions will be returned from the result of the Get-WLDomain Command.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false
-Credential: <PSCredential>
Use credential to access the AdminServer. You can use "-Credential (Get-Credential)" or "-Credential (Get-WLCredential)" To use Get-WLCredential you need run New-WLCredentials command to secure and store credentials in your profile.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false
-SecureConnection: <SwitchParameter>
Use to connect securely (TLS/SSL). The TCP port should be returning in AdminTcpPortSec property of the Get-WLDomain command.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false
-Cache: <SwitchParameter>
User to bypass cache results. Use -Cache:$False

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false
-TimeoutSec: <Int32>
Period of time in seconds that will be allowed to elapse in adminserver before the event is to take place.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false
-WhatIf: <SwitchParameter>

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false
-Confirm: <SwitchParameter>

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false
-InputObject: <PSObject>
Use to enter objects such as domain, server and target in case you do not use the pipe. The input from the pipe is the same as this parameter.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

true (ByValue)
false

Inputs

Outputs

Examples

Notes

Get-WLCluster

Synopsis

Get cluster object from a domain.

Syntax

Get-WLCluster [-InputObject <PSObject>] [-AdminServer <List`1[String]>] [-Name <List`1[String]>] [-Credential <PSCredential>] [-SecureConnection <SwitchParameter>] [-Cache <SwitchParameter>] [-TimeoutSec <Int32>]

Description

Parameters

-InputObject: <PSObject>
Use to enter objects such as domain, server and target in case you do not use the pipe. The input from the pipe is the same as this parameter.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false
-AdminServer: <List`1[String]>
Determine the AdminServer target. Suggestions will be returned from the result of the Get-WLDomain Command.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false
-Name: <List`1[String]>
Filter clusters by Name. (regex)

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
1

false
true
-Credential: <PSCredential>
Use credential to access the AdminServer. You can use "-Credential (Get-Credential)" or "-Credential (Get-WLCredential)" To use Get-WLCredential you need run New-WLCredentials command to secure and store credentials in your profile.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named
Get-WLCredential -Alias Default
false
false
-SecureConnection: <SwitchParameter>
Use to connect securely (TLS/SSL). The TCP port should be returning in AdminTcpPortSec property of the Get-WLDomain command.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named
True
false
false
-Cache: <SwitchParameter>
User to bypass cache results. Use -Cache:$False

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named
True
false
false
-TimeoutSec: <Int32>
Period of time in seconds that will be allowed to elapse in adminserver before the event is to take place.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named
30
false
false

Inputs

Outputs

Examples

Example 1

Get-WLCluster -AdminServer wls.desenv.local.com -Credential (Get-WLCredential -Alias myCred)

Output

Return monitoring data.
This example use alternative stored credential.
   Name            Servers                                                             AdminServer                 
----            -------                                                             -----------                 
infra-desenv-01 {@{name=infra-des-31.local.com; state=RUNNING; health=HEALTH_OK}} wls-infra.desenv.local.com
infra-desenv-02 {@{name=infra-des-32.local.com; state=RUNNING; health=HEALTH_OK}} wls-infra.desenv.local.com

Example 2

Get-WLDomain DES-INFRA | Get-WLCluster

Output

Return monitoring data getting domain value from pipeline.
This example use adminserver information from pipe and default credential previously stored with 'default' alias name.
   Name            Servers                                                             AdminServer                 
----            -------                                                             -----------                 
infra-desenv-01 {@{name=infra-des-31.local.com; state=RUNNING; health=HEALTH_OK}} wls-infra.desenv.local.com
infra-desenv-02 {@{name=infra-des-32.local.com; state=RUNNING; health=HEALTH_OK}} wls-infra.desenv.local.com

Notes

Get-WLCredential

Synopsis

Get weblogic credential stored at default or alternative path.

Syntax

Get-WLCredential [-Name <String>] [-Path <String>]

Description

Parameters

-Path: <String>
Use alternative path.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named
$env:APPDATA\psWeblogic\security
false
false
-Name: <String>

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
0

false
false

Inputs

Outputs

Examples

Example 1

Get-WLCredential

Output

Get all stored credentials.
   Alias   CreationTime        UserName                       Password
-----   ------------        --------                       --------
Default 29/02/2016 17:24:49 weblogic   System.Security.SecureString
myCred  01/03/2016 17:47:06 mike       System.Security.SecureString
user01  08/03/2016 12:16:08 user01     System.Security.SecureString

Notes

Get-WLDatasource

Synopsis

Get datasource object from a domain.

Syntax

Get-WLDatasource [-AdminServer <List`1[String]>] [-Name <String[]>] [-Credential <PSCredential>] [-SecureConnection <SwitchParameter>] [-Cache <SwitchParameter>] [-Management <SwitchParameter>] [-TimeoutSec <Int32>]

Get-WLDatasource [-Name <String[]>] [-InputObject <PSObject>] [-Credential <PSCredential>] [-SecureConnection <SwitchParameter>] [-Cache <SwitchParameter>] [-Management <SwitchParameter>] [-TimeoutSec <Int32>]

Description

Parameters

-AdminServer: <List`1[String]>
Determine the AdminServer target. Suggestions will be returned from the result of the Get-WLDomain Command.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false
-InputObject: <PSObject>
Use to enter objects such as domain, server and target in case you do not use the pipe. The input from the pipe is the same as this parameter.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

true (ByValue)
false
-Credential: <PSCredential>
Use credential to access the AdminServer. You can use "-Credential (Get-Credential)" or "-Credential (Get-WLCredential)" To use Get-WLCredential you need run New-WLCredentials command to secure and store credentials in your profile.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named
(Get-WLCredential -Alias Default)
false
false
-SecureConnection: <SwitchParameter>
Use to connect securely (TLS/SSL). The TCP port should be returning in AdminTcpPortSec property of the Get-WLDomain command.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named
True
false
false
-Cache: <SwitchParameter>
User to bypass cache results. Use -Cache:$False

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named
True
false
false
-TimeoutSec: <Int32>
Period of time in seconds that will be allowed to elapse in adminserver before the event is to take place.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named
30
false
false
-Name: <String[]>
Filter datasource by name.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
1

false
false
-Management: <SwitchParameter>
Use to access the management interface. By default the result is simplified and shows health at runtime. With this parameter the result will be more informative objects and lifecycle methods.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false

Inputs

Outputs

Examples

Example 1

Get-WLDatasource -AdminServer wls01.desenv.local.com -Management

Output

Get management objects of all datasources from a domain.
This example use default credential previously stored with 'default' alias name.
   Name        Targets                           
----        -------                           
jdbc/ds1   {infra-desenv-01, infra-desenv-02}
jdbc/ds2   {infra-desenv-01}

Example 2

Get-WLDomain -AdminServer wls01.desenv.local.com | Get-WLDatasource
This example use adminserver information from pipe and default credential previously stored with 'default' alias name.

Output

   Name        Type   
----        ----   
jdbc/ds1 Generic
jdbc/ds2   Generic

Notes

Get-WLDeployment

Synopsis

Get deployment object from a domain.

Syntax

Get-WLDeployment [-AdminServer <List`1[String]>] [-Name <String[]>] [-Credential <PSCredential>] [-Type <String>] [-SecureConnection <SwitchParameter>] [-Cache <SwitchParameter>] [-Management <SwitchParameter>] [-TimeoutSec <Int32>]

Get-WLDeployment [-Name <String[]>] [-InputObject <PSObject>] [-Credential <PSCredential>] [-Type <String>] [-SecureConnection <SwitchParameter>] [-Cache <SwitchParameter>] [-Management <SwitchParameter>] [-TimeoutSec <Int32>]

Description

Parameters

-AdminServer: <List`1[String]>
Determine the AdminServer target. Suggestions will be returned from the result of the Get-WLDomain Command.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false
-InputObject: <PSObject>
Use to enter objects such as domain, server and target in case you do not use the pipe. The input from the pipe is the same as this parameter.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

true (ByValue)
false
-Credential: <PSCredential>
Use credential to access the AdminServer. You can use "-Credential (Get-Credential)" or "-Credential (Get-WLCredential)" To use Get-WLCredential you need run New-WLCredentials command to secure and store credentials in your profile.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false
-Type: <String>
Filter deployment by type "application or library". When using this parameter the result may contain attributes specific to each type.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false
-SecureConnection: <SwitchParameter>
Use to connect securely (TLS/SSL). The TCP port should be returning in AdminTcpPortSec property of the Get-WLDomain command.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false
-Cache: <SwitchParameter>
User to bypass cache results. Use -Cache:$False

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false
-TimeoutSec: <Int32>
Period of time in seconds that will be allowed to elapse in adminserver before the event is to take place.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named
30
false
false
-Name: <String[]>
Filter deployment by name.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
1

false
false
-Management: <SwitchParameter>
Use to access the management interface. By default the result is simplified and shows health at runtime. With this parameter the result will be more informative objects and lifecycle methods.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false

Inputs

Outputs

Examples

Example 1

Get-WLDeployment -AdminServer wls01.desenv.local.com -Management

Output

Get management objects of all deployments from a domain.
This example use default credential previously stored with 'default' alias name.

Example 2

Get-WLDatasource -AdminServer wls01.prod.local.com -Management | % {$_.test()} | select -ExpandProperty messages

Output

Rua a test of all datasoucers in a domain.
   message                                                                                    severity
-------                                                                                    --------
Data Source 'jdbc/ds01' is working correctly.                                              SUCCESS 
Data Source 'jdbc/ds02' is working correctly.                                              SUCCESS 
Data Source 'jdbc/ds03'. The remote server returned an error: (400) Bad Request.           ERROR

Example 3

Get-WLDatasource -AdminServer wls01.local.com -Management | % {$_.Reset()} | select -ExpandProperty messages

Output

Restarts all datasouces a domain.
   message                                                  severity
-------                                                  --------
Data Source 'jdbc/ds01' was successfully reset.          SUCCESS 
Data Source 'jdbc/ds02' was successfully reset.          SUCCESS

Notes

Get-WLDomain

Synopsis

Get domain object.

Syntax

Get-WLDomain [-AdminServer <String[]>] [-Name <String[]>] [-Cache <SwitchParameter>] [-Environment <String[]>] [-Version <Version[]>] [-TimeoutSec <Int32>]

Description

Parameters

-TimeoutSec: <Int32>
Period of time in seconds that will be allowed to elapse in adminserver before the event is to take place.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named
30
false
false
-AdminServer: <String[]>
Filters by AdminServer. Use the DNS name.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false
-Name: <String[]>
Filter by domain name. Use the short domain name.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
1

false
false
-Cache: <SwitchParameter>
User to bypass cache results. Use -Cache:$False

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false
-Environment: <String[]>
Filter results by environment. This parameter is the environment field registered in the inventory.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false
-Version: <Version[]>
Filters the domain version. Use the Semantic Versioning as well as "12.1.3"

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false

Inputs

Outputs

Examples

Example 1

Get-WLDomain | select -First 2

Output

   Name            : wls01
AdminServer     : wls01.desenv.local.com
AdminTcpPort    : 7304
AdminTcpPortSec : 443
Version         : 12.1.3
Environment      : Desenv
ResourceType    : domain

Name            : wls01
AdminServer     : wls01.desenv.local.com
AdminTcpPort    : 7304
AdminTcpPortSec : 443
Version         : 12.1.3
Environment      : Desenv
ResourceType    : domain

Example 2

Get-WLDomain -Name wls | ft

Output

   Name             AdminServer                    AdminTcpPort AdminTcpPortSec Version Environment ResourceType
----             -----------                    ------------ --------------- ------- ---------- ------------
wls01         wls01.desenv.local.com           7304 443             12.1.3  Desenv     domain      
wls02         wls02.desenv.local.com           7304 443             12.1.3  Desenv     domain

Notes

Get-WLEnvironment

Synopsis

Get all environment options.

Syntax

Get-WLEnvironment

Description

Parameters

Inputs

Outputs

Examples

Notes

Get-WLjob

Synopsis

Get job object from a domain.

Syntax

Get-WLjob [-AdminServer <String[]>] [-SecureConnection <SwitchParameter>] [-InputObject <PSObject>] [-Credential <PSCredential>] [-Cache <SwitchParameter>] [-TimeoutSec <Int32>]

Description

Parameters

-AdminServer: <String[]>
Determine the AdminServer target. Suggestions will be returned from the result of the Get-WLDomain Command.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false
-InputObject: <PSObject>
Use to enter objects such as domain, server and target in case you do not use the pipe. The input from the pipe is the same as this parameter.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

true (ByValue)
false
-SecureConnection: <SwitchParameter>
Use to connect securely (TLS/SSL). The TCP port should be returning in AdminTcpPortSec property of the Get-WLDomain command.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false
-Cache: <SwitchParameter>
User to bypass cache results. Use -Cache:$False

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false
-Credential: <PSCredential>
Use credential to access the AdminServer. You can use "-Credential (Get-Credential)" or "-Credential (Get-WLCredential)" To use Get-WLCredential you need run New-WLCredentials command to secure and store credentials in your profile.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false
-TimeoutSec: <Int32>
Period of time in seconds that will be allowed to elapse in adminserver before the event is to take place.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named
30
false
false

Inputs

Outputs

Examples

Notes

Get-WLServer

Synopsis

Get server object from a domain.

Syntax

Get-WLServer [-AdminServer <List`1[String]>] [-Name <List`1[String]>] [-Credential <PSCredential>] [-SecureConnection <SwitchParameter>] [-IncludeAdminServer <SwitchParameter>] [-Cache <SwitchParameter>] [-Management <SwitchParameter>] [-TimeoutSec <Int32>] [-WhatIf <SwitchParameter>] [-Confirm <SwitchParameter>]

Get-WLServer [-InputObject <PSObject>] [-AdminServer <List`1[String]>] [-Name <List`1[String]>] [-Credential <PSCredential>] [-SecureConnection <SwitchParameter>] [-IncludeAdminServer <SwitchParameter>] [-Cache <SwitchParameter>] [-Management <SwitchParameter>] [-TimeoutSec <Int32>] [-WhatIf <SwitchParameter>] [-Confirm <SwitchParameter>]

Get-WLServer [-AdminServer <List`1[String]>] [-Name <List`1[String]>] [-Credential <PSCredential>] [-SecureConnection <SwitchParameter>] [-IncludeAdminServer <SwitchParameter>] [-Cache <SwitchParameter>] [-Management <SwitchParameter>] [-TimeoutSec <Int32>] [-WhatIf <SwitchParameter>] [-Confirm <SwitchParameter>]

Description

Parameters

-InputObject: <PSObject>
Use to enter objects such as domain, server and target in case you do not use the pipe. The input from the pipe is the same as this parameter.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

true (ByValue)
false
-AdminServer: <List`1[String]>
Determine the AdminServer target. Suggestions will be returned from the result of the Get-WLDomain Command.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false
-Name: <List`1[String]>
Filter servers by Name. (regex)

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
1

false
false
-Credential: <PSCredential>
Use credential to access the AdminServer. You can use "-Credential (Get-Credential)" or "-Credential (Get-WLCredential)" To use Get-WLCredential you need run New-WLCredentials command to secure and store credentials in your profile.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false
-SecureConnection: <SwitchParameter>
Use to connect securely (TLS/SSL). The TCP port should be returning in AdminTcpPortSec property of the Get-WLDomain command.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false
-Cache: <SwitchParameter>
User to bypass cache results. Use -Cache:$False

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false
-TimeoutSec: <Int32>
Period of time in seconds that will be allowed to elapse in adminserver before the event is to take place.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named
30
false
false
-IncludeAdminServer: <SwitchParameter>
Use to include AdminServer in the result.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false
-Management: <SwitchParameter>
Use to access the management interface. By default the result is simplified and shows health at runtime. With this parameter the result will be more informative objects and lifecycle methods.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false
-WhatIf: <SwitchParameter>

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false
-Confirm: <SwitchParameter>

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false

Inputs

Outputs

Examples

Notes

Get-WLTarget

Synopsis

Get target object from a domain.

Syntax

Get-WLTarget [-AdminServer <String[]>] [-Name <String[]>] [-InputObject <PSObject>] [-Credential <PSCredential>] [-Type <String>] [-SecureConnection <SwitchParameter>] [-Cache <SwitchParameter>] [-Management <SwitchParameter>] [-TimeoutSec <Int32>]

Description

Parameters

-AdminServer: <String[]>
Determine the AdminServer target. Suggestions will be returned from the result of the Get-WLDomain Command.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false
-Name: <String[]>
Filter targets by Name. (regex)

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
1

false
false
-InputObject: <PSObject>
Use to enter objects such as domain, server and target in case you do not use the pipe. The input from the pipe is the same as this parameter.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

true (ByValue)
false
-Credential: <PSCredential>
Use credential to access the AdminServer. You can use "-Credential (Get-Credential)" or "-Credential (Get-WLCredential)" To use Get-WLCredential you need run New-WLCredentials command to secure and store credentials in your profile.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false
-Type: <String>
Filter Target by type. (Server or Cluster)

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false
-SecureConnection: <SwitchParameter>
Use to connect securely (TLS/SSL). The TCP port should be returning in AdminTcpPortSec property of the Get-WLDomain command.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false
-Cache: <SwitchParameter>
User to bypass cache results. Use -Cache:$False

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false
-TimeoutSec: <Int32>
Period of time in seconds that will be allowed to elapse in adminserver before the event is to take place.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named
30
false
false
-Management: <SwitchParameter>
Use to access the management interface. By default the result is simplified and shows health at runtime. With this parameter the result will be more informative objects and lifecycle methods.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false

Inputs

Outputs

Examples

Notes

Invoke-WlstScript

Synopsis

Run jython scripts

Syntax

Invoke-WlstScript [-InputObject <PSObject>] [-Credential <PSCredential>] [-SecureConnection <SwitchParameter>] [-ScriptPath <String>] [-ObjectPrefix <String>] [-ObjectDelimiter <Char>] [-PassThru <SwitchParameter>] [-CurrentBaseDir <SwitchParameter>] [-WhatIf <SwitchParameter>] [-ShowScriptOnly <SwitchParameter>] [-Arguments <String[]>]

Invoke-WlstScript [-InputObject <PSObject>] [-Credential <PSCredential>] [-SecureConnection <SwitchParameter>] [-ObjectPrefix <String>] [-ObjectDelimiter <Char>] [-PassThru <SwitchParameter>] [-CurrentBaseDir <SwitchParameter>] [-WhatIf <SwitchParameter>] [-ShowScriptOnly <SwitchParameter>] [-Arguments <String[]>] [-BuiltInScript <String>]

Description

Create your scripts normally and, if you use the connect method, use it empty in the original position - "connect ()" - without quotes. Enter the path of the python script in the ScriptPath parameter. CMDLET will use either the pipe or InputObjet domain informations and the credentials of the Credential parameter.

Parameters

-InputObject: <PSObject>
Use to enter objects such as domain, server and target in case you do not use the pipe. The input from the pipe is the same as this parameter.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

true (ByValue)
false
-Credential: <PSCredential>
Use credential to access the AdminServer. You can use "-Credential (Get-Credential)" or "-Credential (Get-WLCredential)" To use Get-WLCredential you need run New-WLCredentials command to secure and store credentials in your profile.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false
-SecureConnection: <SwitchParameter>
Use to connect securely (TLS/SSL). The TCP port should be returning in AdminTcpPortSec property of the Get-WLDomain command.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false
-ScriptPath: <String>
The path to the python script.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false
-PassThru: <SwitchParameter>
Ignores any attempt to format the output. Shows the raw output in the Result attribute.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false
-CurrentBaseDir: <SwitchParameter>
Forces the script to run in the current directory it is in. This is required when there are dependencies that depend on the execution path.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false
-Arguments: <String[]>
Arguments to be used in the python script.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false
-WhatIf: <SwitchParameter>
A variable 'whatif = True' will be inserted at the start of the python script which can be used programmatically in the .py script

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named
False
false
false
-BuiltInScript: <String>
Predefined generic scripts.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false
-ObjectPrefix: <String>
Defines which prefix will be used to filter the output that will be converted from the CSV format to psCustomObject.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false
-ObjectDelimiter: <Char>
Defines the delimiter for the results of the filter performed with the ObjectPrefix parameter. Outputs will be converted from a CSV format to Object.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named
,
false
false
-ShowScriptOnly: <SwitchParameter>
If present the script will NOT run the script but only print the result source code on the screen.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false

Inputs

Outputs

Examples

Example 1

Get-WLDomain -AdminServer wls-infra.local.com | Invoke-WlstScript -BuiltInScript Get-JavaVersion.py -ShowScriptOnly

Output

The -ShowScriptOnly NOT run the script but only print the result source code on the screen.
   whatif = False
domain_hashtable={"Name":"WLDomain01","AdminServer":"wls-infra.local.com","AdminTcpPort":7340,"AdminTcpPortSec":"443","Version":"12.2.1.2","En
vironment":"DEV","ServiceName":"AdminServer_DEV-INFRA","MW_HOME":"O:\\Oracle\\WLS_12.2.1\\DEV-INFRA\\MW_HOME","Description":"DEV JEE Equipe de Infr
aestrutura.","ResourceType":"Domain"}
def getServerInfo():
    domainConfig()
    serverNames = cmo.getServers()
    domainRuntime()
    print '==>AdminServer,Name,JavaVersion'
    for name in serverNames:
        try:
            serverName = name.getName()
            cd('/ServerLifeCycleRuntimes/' + serverName)
            state = cmo.getState()
            if state == "SHUTDOWN":
                print  '==>' + domain_hashtable['AdminServer'] + ',' + serverName + ',' + 'SHUTDOWN'
            else:                
                cd("/ServerRuntimes/" + serverName + "/JVMRuntime/" + serverName)
                print  '==>' + domain_hashtable['AdminServer'] + ',' + serverName + ',' + cmo.getJavaVersion()
        except Exception, e:
            print  '==>' + domain_hashtable['AdminServer'] + ',' + serverName + ',' + e
            pass

try:
    connect('user01','**********','t3://wls-infra.dev.local.com:7340')
    getServerInfo()
finally:
    disconnect()
    exit(defaultAnswer='y')

Example 2

Get-WLDomain -AdminServer wls-infra.local.com | Invoke-WlstScript -BuiltInScript Get-JavaVersion.py | Select-Object -ExpandProperty Result

Output

   AdminServer                         Name                               JavaVersion
-----------                              ----                                   -----------
wls-infra.dev.local.com       AdminServer                     1.8.0_121  
wls-infra.dev.local.com      infra-core-01.infra.tj.rs       1.7.0_67
wls-infra.dev.local.com      infra-dev-21.local.com      1.8.0_112

Example 3

Get-WLDomain -AdminServer wls-domain01.local.com | Invoke-WlstScript -ScriptPath c:\WebLogic\InvokeByPowershell\Set-DsProperties.py -WhatIf -Arguments 'jdbc/d' | fl

Output

The -whatIf parameter inserts a variable into the python code that can be used to simulate execution.
The -Arguments parameter passes the arguments to the python script in the order they were entered.
AdminServer : wls-domain01.local.com
Result :
Initializing WebLogic Scripting Tool (WLST) ...

Welcome to WebLogic Server Administration Scripting Shell

Type help() for help on available commands

Connecting to t3://wls-domain01.local.com:7307 with userid user01...
Successfully connected to Admin Server "AdminServer" that belongs to domain "WLDomain01".

Warning: An insecure protocol was used to connect to the server.
To ensure on-the-wire security, the SSL port or Admin port should be used instead.

Location changed to edit tree.
This is a writable tree with DomainMBean as the root.
To make changes you will need to start an edit session via startEdit().
For more help, use help('edit').

Starting an edit session ...
Started edit session, be sure to save and activate your changes once you are done.

==> WhatIf is present: 1
==> Argument match: jdbc/d

jdbc/docs
Set StatementTimeout -1 to 300
Set ConnectionCreationRetryFrequencySeconds 0 to 120
Set InactiveConnectionTimeoutSeconds 0 to 10
Set HighestNumWaiters 2147483647 to 90
jdbc/docs_back
Set StatementTimeout -1 to 300
Set ConnectionCreationRetryFrequencySeconds 0 to 120
Set InactiveConnectionTimeoutSeconds 0 to 10
Set HighestNumWaiters 2147483647 to 90

==> ToChange 2 datasources

Edit session is cancelled successfully.
Exiting WebLogic Scripting Tool.

Notes

New-WLCredential

Synopsis

Create new credential to AdminServer and store into user profile.

Syntax

New-WLCredential [-UserName <String>] [-Password <SecureString>] -Name <String> [-Path <String>] [-Force <SwitchParameter>]

Description

Create a new credential and stored in your profile under $env:APPDATA\psWeblogic\security If you create a credential with alias ' Default' then you need not inform it in cmdlets that already will locate it automatically .

Parameters

-UserName: <String>
Use username to the new credential.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
0

false
false
-Path: <String>
Optionally use an alternative way to store the new credentials .

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false
-Force: <SwitchParameter>
If a credential with the same alias exists this parameter forced to overwritten .

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false
-Password: <SecureString>
Type your password

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
1

false
false
-Name: <String>
Use a name to identify this credential.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

true
2

false
false

Inputs

Outputs

Examples

Example 1

New-WLCredential -UserName weblogic -Name Default

Output

Creates a default credential to be used automatically whenever the -Credential parameter is not informed .
The password is required to execute this command
   Alias        : Default
CreationTime : 29/02/2016 17:24:49
UserName     : weblogic
Password     : System.Security.SecureString

Example 2

New-WLCredential -Name cred01 -UserName user01

Output

Create a credential to user user01
   Alias  CreationTime        UserName                     Password
-----  ------------        --------                     --------
user01 08/03/2016 12:16:08 user01   System.Security.SecureString

Notes

New-WLDatasource

Synopsis

Create a new Datasource.

Syntax

New-WLDatasource [-AdminServer <String>] [-Credential <PSCredential>] [-SecureConnection <SwitchParameter>] [-Name <String>] [-Url <String>] [-InputPasswordAsObject <PSObject>] [-InputUrlAsObject <PSObject>] [-Targets <String[]>] [-JndiNames <String[]>] [-DsCredential <PSCredential>] [-MinCapacity <Int32>] [-MaxCapacity <Int32>] [-InitialCapacity <Int32>] [-DsUser <String>] [-DsPassword <SecureString>] [-SkeepChecks <SwitchParameter>] [-TimeoutSec <Int32>] [-WhatIf <SwitchParameter>] [-Confirm <SwitchParameter>]

New-WLDatasource [-AdminServer <String>] [-InputObject <PSObject>] [-Credential <PSCredential>] [-SecureConnection <SwitchParameter>] [-Name <String>] [-Url <String>] [-InputPasswordAsObject <PSObject>] [-InputUrlAsObject <PSObject>] [-Targets <String[]>] [-JndiNames <String[]>] [-DsCredential <PSCredential>] [-MinCapacity <Int32>] [-MaxCapacity <Int32>] [-InitialCapacity <Int32>] [-DsUser <String>] [-DsPassword <SecureString>] [-SkeepChecks <SwitchParameter>] [-TimeoutSec <Int32>] [-WhatIf <SwitchParameter>] [-Confirm <SwitchParameter>]

New-WLDatasource [-AdminServer <String>] [-Credential <PSCredential>] [-SecureConnection <SwitchParameter>] [-Name <String>] [-Url <String>] [-InputPasswordAsObject <PSObject>] [-InputUrlAsObject <PSObject>] [-DatasourceType <String>] [-Targets <String[]>] [-JndiNames <String[]>] [-DsCredential <PSCredential>] [-MinCapacity <Int32>] [-MaxCapacity <Int32>] [-InitialCapacity <Int32>] [-DsUser <String>] [-DsPassword <SecureString>] [-SkeepChecks <SwitchParameter>] [-TimeoutSec <Int32>] [-WhatIf <SwitchParameter>] [-Confirm <SwitchParameter>]

Description

A datasource can be created from template, response file or other datasource.

Parameters

-Name: <String>
Name to new datasource.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false
-InputObject: <PSObject>
Use to enter objects such as domain, server and target in case you do not use the pipe. The input from the pipe is the same as this parameter.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

true (ByValue)
false
-Credential: <PSCredential>
Use credential to access the AdminServer. You can use "-Credential (Get-Credential)" or "-Credential (Get-WLCredential)" To use Get-WLCredential you need run New-WLCredentials command to secure and store credentials in your profile.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false
-SecureConnection: <SwitchParameter>
Use to connect securely (TLS/SSL). The TCP port should be returning in AdminTcpPortSec property of the Get-WLDomain command.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false
-DsUser: <String>
Use the database username to datasource.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false
-DsPassword: <SecureString>
User the database password to datasource.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false
-TimeoutSec: <Int32>
Period of time in seconds that will be allowed to elapse in adminserver before the event is to take place.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false
-Targets: <String[]>
Use the target where the new datasource will be applied.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false
-JndiNames: <String[]>
Use the JNDI name to this datasource. If not specified it will be the same as the name parameter.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false
-AdminServer: <String>
Determine the AdminServer target. Suggestions will be returned from the result of the Get-WLDomain Command.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false
-Url: <String>
Use the Url (connection string) to be used in the new datasource.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false
-InputPasswordAsObject: <PSObject>
Use a object or a set of objects[name=, password=] That is, at a minimum the attributes name= and password=

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false
-InputUrlAsObject: <PSObject>

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false
-DsCredential: <PSCredential>

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false
-MinCapacity: <Int32>

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false
-MaxCapacity: <Int32>

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false
-InitialCapacity: <Int32>

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false
-SkeepChecks: <SwitchParameter>

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false
-WhatIf: <SwitchParameter>

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false
-Confirm: <SwitchParameter>

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false
-DatasourceType: <String>

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false

Inputs

Outputs

Examples

Example 1

$dsTemplate = Get-WLDatasource -AdminServer wls01.desenv.local.com -Management -Name jdbc/ds01
$dsTemplate.targets = @("server01","cluster02")
$dsTemplate | New-WLDatasource -AdminServer wls02.desenv.local.com

Output

Takes a datasource as a model.
Changes targets property.
   Name     : jdbc/ds01
Targets  : {infra-desenv-01}
Messages : {@{message=Successfully created 'jdbc/ds01'.; severity=SUCCESS}}

Notes

New-WLDeployment

Synopsis

Deploy new application or library.

Syntax

New-WLDeployment [-AdminServer <List`1[String]>] [-Name <String>] [-InputObject <PSObject>] [-Credential <PSCredential>] [-Type <String>] [-SecureConnection <SwitchParameter>] [-DeploymentPath <String[]>] [-InFile <String>] [-Targets <String[]>] [-TimeoutSec <Int32>]

Description

Parameters

-AdminServer: <List`1[String]>
Determine the AdminServer target. Suggestions will be returned from the result of the Get-WLDomain Command.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false
-Name: <String>
The deployment name.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false
-InputObject: <PSObject>
Use to enter objects such as domain, server and target in case you do not use the pipe. The input from the pipe is the same as this parameter.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

true (ByValue)
false
-Credential: <PSCredential>
Use credential to access the AdminServer. You can use "-Credential (Get-Credential)" or "-Credential (Get-WLCredential)" To use Get-WLCredential you need run New-WLCredentials command to secure and store credentials in your profile.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false
-Type: <String>
The deployment type "application" or "library" .

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named
application
false
false
-SecureConnection: <SwitchParameter>
Use to connect securely (TLS/SSL). The TCP port should be returning in AdminTcpPortSec property of the Get-WLDomain command.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false
-DeploymentPath: <String[]>
The path to the package to be installed. This is the note where the package will remain and should not be removed after installation.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false
-InFile: <String>
The path to the package to be installed. A copy of this package will be sent to the AdminServer uploads directory.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false
-Targets: <String[]>
The target where this package will be installed.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false
-TimeoutSec: <Int32>
Period of time in seconds that will be allowed to elapse in adminserver before the event is to take place.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false

Inputs

Outputs

Examples

Example 1

New-WLDeployment -AdminServer wls01.local.com  -Targets cluster01 -InFile D:\_work\temp\jax-rs-2.0.war

Output

   messages : {@{message=Deployed the application 'jax-rs-2.0'.; severity=SUCCESS}}
item     : @{name=ADTR-1; id=1; type=deployment; description=[Deployer:149026]deploy application jax-rs-2.0 on infra-dev-21.local.com.; 
           operation=deploy; targets=System.Object[]; beginTime=1510854853119; endTime=1510854856119; status=completed; deploymentName=jax-rs-2.0}

Notes

New-WLDomain

Synopsis

Create a new weblogic domain into inventory.

Syntax

New-WLDomain -AdminServer <String> [-Name <String>] -AdminTcpPort <Int32> [-AdminTcpPortSec <Int32>] [-SecureConnection <SwitchParameter>] [-Environment <String>] [-ServiceName <String>] [-Version <Version>] [-MW_HOME <String>] [-Description <String>] [-TimeoutSec <Int32>]

Description

Parameters

-AdminServer: <String>
Determine the AdminServer target. Suggestions will be returned from the result of the Get-WLDomain Command.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

true
named

false
false
-Name: <String>
Use the short domain name.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false
-AdminTcpPort: <Int32>
Use the TCP port for the HTTP service that the server is running.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

true
named

false
false
-AdminTcpPortSec: <Int32>
Use the TCP port for the HTTPS service that the server is running.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false
-SecureConnection: <SwitchParameter>
Use to connect securely (TLS/SSL). The TCP port should be returning in AdminTcpPortSec property of the Get-WLDomain command.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false
-Environment: <String>
Type the environment.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false
-ServiceName: <String>
The name of the service that is running AdminServer.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false
-Version: <Version>
Use the Semantic Versioning as well as "12.1.3"

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false
-MW_HOME: <String>
The middleware installation path.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false
-Description: <String>

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false
-TimeoutSec: <Int32>
Period of time in seconds that will be allowed to elapse in adminserver before the event is to take place.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false

Inputs

Outputs

Examples

Notes

Remove-WLCredential

Synopsis

Remove weblogic credential stored at default or alternative path.

Syntax

Remove-WLCredential -Name <String> [-Path <String>]

Description

Parameters

-Path: <String>

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false
-Name: <String>

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

true
1

true (ByPropertyName)
false

Inputs

Outputs

Examples

Example 1

Remove-WLCredential -Name user01

Output

Remove stored credential width alias user01.

Notes

Remove-WLDatasource

Synopsis

Removes an existing datasource.

Syntax

Remove-WLDatasource [-AdminServer <List`1[String]>] [-Credential <PSCredential>] [-SecureConnection <SwitchParameter>] [-Name <String[]>] [-TimeoutSec <Int32>] [-WhatIf <SwitchParameter>] [-Confirm <SwitchParameter>]

Remove-WLDatasource [-InputObject <PSObject>] [-Credential <PSCredential>] [-Name <String[]>] [-TimeoutSec <Int32>] [-WhatIf <SwitchParameter>] [-Confirm <SwitchParameter>]

Description

Parameters

-AdminServer: <List`1[String]>
Determine the AdminServer target. Suggestions will be returned from the result of the Get-WLDomain Command.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false
-Credential: <PSCredential>
Use credential to access the AdminServer. You can use "-Credential (Get-Credential)" or "-Credential (Get-WLCredential)" To use Get-WLCredential you need run New-WLCredentials command to secure and store credentials in your profile.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named
(Get-WLCredential -Alias Default)
false
false
-SecureConnection: <SwitchParameter>
Use to connect securely (TLS/SSL). The TCP port should be returning in AdminTcpPortSec property of the Get-WLDomain command.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named
True
false
false
-Name: <String[]>
Filter datasource by name.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false
-TimeoutSec: <Int32>
Period of time in seconds that will be allowed to elapse in adminserver before the event is to take place.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named
30
false
false
-WhatIf: <SwitchParameter>

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false
-Confirm: <SwitchParameter>

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false
-InputObject: <PSObject>
Use to enter objects such as domain, server and target in case you do not use the pipe. The input from the pipe is the same as this parameter.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

true (ByValue)
false

Inputs

Outputs

Examples

Notes

Remove-WLDeployment

Synopsis

Removes an existing deployment.

Syntax

Remove-WLDeployment [-AdminServer <List`1[String]>] [-Name <String[]>] [-Credential <PSCredential>] [-SecureConnection <SwitchParameter>] [-TimeoutSec <Int32>] [-WhatIf <SwitchParameter>] [-Confirm <SwitchParameter>]

Remove-WLDeployment [-Name <String[]>] [-InputObject <PSObject>] [-Credential <PSCredential>] [-TimeoutSec <Int32>] [-WhatIf <SwitchParameter>] [-Confirm <SwitchParameter>]

Description

Parameters

-AdminServer: <List`1[String]>
Determine the AdminServer target. Suggestions will be returned from the result of the Get-WLDomain Command.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false
-Name: <String[]>
Filter deployment by name.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
1

false
false
-Credential: <PSCredential>
Use credential to access the AdminServer. You can use "-Credential (Get-Credential)" or "-Credential (Get-WLCredential)" To use Get-WLCredential you need run New-WLCredentials command to secure and store credentials in your profile.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false
-SecureConnection: <SwitchParameter>
Use to connect securely (TLS/SSL). The TCP port should be returning in AdminTcpPortSec property of the Get-WLDomain command.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false
-TimeoutSec: <Int32>
Period of time in seconds that will be allowed to elapse in adminserver before the event is to take place.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false
-WhatIf: <SwitchParameter>

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false
-Confirm: <SwitchParameter>

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false
-InputObject: <PSObject>
Use to enter deployment objects. The input from the pipe is the same as this parameter.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

true (ByValue)
false

Inputs

Outputs

Examples

Notes

Remove-WLDomain

Synopsis

Removes an existing weblogic domain from inventory.

Syntax

Remove-WLDomain [-AdminServer <List`1[String]>] [-SecureConnection <SwitchParameter>] [-TimeoutSec <Int32>] [-WhatIf <SwitchParameter>] [-Confirm <SwitchParameter>]

Remove-WLDomain [-InputObject <PSObject>] [-TimeoutSec <Int32>] [-WhatIf <SwitchParameter>] [-Confirm <SwitchParameter>]

Description

Parameters

-AdminServer: <List`1[String]>
Determine the AdminServer target. Suggestions will be returned from the result of the Get-WLDomain Command.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false
-SecureConnection: <SwitchParameter>
Use to connect securely (TLS/SSL). The TCP port should be returning in AdminTcpPortSec property of the Get-WLDomain command.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false
-TimeoutSec: <Int32>
Period of time in seconds that will be allowed to elapse in adminserver before the event is to take place.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false
-WhatIf: <SwitchParameter>

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false
-Confirm: <SwitchParameter>

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false
-InputObject: <PSObject>
Use to enter domain objects. The input from the pipe is the same as this parameter.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

true (ByValue)
false

Inputs

Outputs

Examples

Notes

Repair-WLCacheIndex

Synopsis

Rebuild the index cache to current powershell session.

Syntax

Repair-WLCacheIndex

Description

Parameters

Inputs

Outputs

Examples

Notes

Restart-WLServer

Synopsis

Changes the life cycle of the server object to shutdown and then to running.

Syntax

Restart-WLServer [-Force <SwitchParameter>] [-Throttling <Int32>] [-TimeoutSec <Int32>] [-WhatIf <SwitchParameter>] [-Confirm <SwitchParameter>]

Restart-WLServer [-InputObject <PSObject>] [-Force <SwitchParameter>] [-Throttling <Int32>] [-TimeoutSec <Int32>] [-WhatIf <SwitchParameter>] [-Confirm <SwitchParameter>]

Restart-WLServer [-AdminServer <List`1[String]>] [-Name <List`1[String]>] [-SecureConnection <SwitchParameter>] [-Credential <PSCredential>] [-Force <SwitchParameter>] [-Throttling <Int32>] [-TimeoutSec <Int32>] [-WhatIf <SwitchParameter>] [-Confirm <SwitchParameter>]

Description

Parameters

-InputObject: <PSObject>
Use to enter server objects. The input from the pipe is the same as this parameter.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

true (ByValue)
false
-AdminServer: <List`1[String]>
Determine the AdminServer target. Suggestions will be returned from the result of the Get-WLDomain Command.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
true
-Name: <List`1[String]>
Filter servers by Name. (regex)

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
true
-Credential: <PSCredential>
Use credential to access the AdminServer. You can use "-Credential (Get-Credential)" or "-Credential (Get-WLCredential)" To use Get-WLCredential you need run New-WLCredentials command to secure and store credentials in your profile.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false
-TimeoutSec: <Int32>
Period of time in seconds that will be allowed to elapse in adminserver before the event is to take place.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false
-Force: <SwitchParameter>
Force the server to stop. If using this parameter the server will wait for the closing of all the active sessions.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false
-Throttling: <Int32>
It regulates the number of objects that will be executed in parallel.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false
-WhatIf: <SwitchParameter>

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false
-Confirm: <SwitchParameter>

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false
-SecureConnection: <SwitchParameter>
Use to connect securely (TLS/SSL). The TCP port should be returning in AdminTcpPortSec property of the Get-WLDomain command.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false

Inputs

Outputs

Examples

Example 1

Get-WLServer -AdminServer wls01.local.com | Restart-WLServer -Throttling 2

Output

Restart  managed servers on wls01.local.com domain. Two at a time.
This example use adminserver information from pipe and default credential previously stored with 'default' alias name.

Example 2

Get-WLCluster -AdminServer wls01.local.com -Name cluster01 | Restart-WLServer

Output

Restart all managed servers on weblogic cluster 'cluster01'
This example use adminserver information from pipe and default credential previously stored with 'default' alias name.

Notes

Set-WLEnvironment

Synopsis

Set environment options.

Syntax

Set-WLEnvironment [-DomainsInfoPath <String>] [-DomainsInfoPathPublish <String>] [-WLST <String>] [-CacheEnable <Object>] [-TTLCacheSeconds <Int32>] [-DebugEnable <Object>]

Description

Parameters

-DomainsInfoPath: <String>
Path for reading the inventory of the weblogic environment where the information of each domain is stored. It can be HTTP, local file systems or network. It should also be the same target of the DomainsInfoPathPublish parameter.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
0

false
false
-DomainsInfoPathPublish: <String>
Path for inventory writing, to be used by the 'New-Domain' Cmdlet. They are the same location as DomainsInfoPath, however, it can be used with another protocol, such as SMB or NFS.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
1

false
false
-WLST: <String>
Full path of the wlst.sh or wlst.cmd file. The WebLogic Scripting Tool (WLST) is a command-line scripting interface that system administrators and operators use to monitor and manage WebLogic Server instances and domains. https://docs.oracle.com/cd/E13222_01/wls/docs90/config_scripting/using_WLST.html

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
2

false
false
-CacheEnable: <Object>
Enables or disables the cache feature. This option allows the module to maintain a cache of queries in the weblogic domains.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
3

false
false
-TTLCacheSeconds: <Int32>
Time, in seconds, that the cache will be considered valid.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
4

false
false
-DebugEnable: <Object>
The debug option writes additional information to the log file. Path $env:APPDATA\psWeblogic\log\

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
5

false
false

Inputs

Outputs

Examples

Notes

Start-WLServer

Synopsis

Changes the lifecycle of the server object to running.

Syntax

Start-WLServer [-InputObject <PSObject>] [-AdminServer <List`1[String]>] [-Name <List`1[String]>] [-Credential <PSCredential>] [-ResumeOnly <SwitchParameter>] [-Throttling <Int32>] [-TimeoutSec <Int32>]

Description

Parameters

-InputObject: <PSObject>
Use to enter server objects. The input from the pipe is the same as this parameter.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false
-AdminServer: <List`1[String]>
Determine the AdminServer target. Suggestions will be returned from the result of the Get-WLDomain Command.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false
-Name: <List`1[String]>
Filter servers by Name. (regex)

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
1

false
false
-Credential: <PSCredential>
Use credential to access the AdminServer. You can use "-Credential (Get-Credential)" or "-Credential (Get-WLCredential)" To use Get-WLCredential you need run New-WLCredentials command to secure and store credentials in your profile.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false
-ResumeOnly: <SwitchParameter>
It only start the server if it is in Suspend mode.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false
-TimeoutSec: <Int32>
Period of time in seconds that will be allowed to elapse in adminserver before the event is to take place.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named
30
false
false
-Throttling: <Int32>
It regulates the number of objects that will be executed in parallel.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false

Inputs

Outputs

Examples

Example 1

Get-WLServer -AdminServer wls01.local.com | Start-WLServer -Throttling 2

Output

Start  managed servers on wls01.local.com domain. Two at a time.
This example use adminserver information from pipe and default credential previously stored with 'default' alias name.

Example 2

Get-WLCluster -AdminServer wls01.local.com -Name cluster01 | Start-WLServer

Output

Start all managed servers on weblogic cluster 'cluster01'.
This example use adminserver information from pipe and default credential previously stored with 'default' alias name.

Notes

Stop-WLServer

Synopsis

Changes the lifecycle of the server object to shutdown.

Syntax

Stop-WLServer [-InputObject <PSObject>] [-AdminServer <List`1[String]>] [-Name <List`1[String]>] [-Credential <PSCredential>] [-SuspendOnly <SwitchParameter>] [-Force <SwitchParameter>] [-Throttling <Int32>] [-TimeoutSec <Int32>]

Description

Parameters

-InputObject: <PSObject>
Use to enter server objects. The input from the pipe is the same as this parameter.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false
-AdminServer: <List`1[String]>
Determine the AdminServer target. Suggestions will be returned from the result of the Get-WLDomain Command.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false
-Name: <List`1[String]>
Filter servers by Name. (regex)

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
1

false
false
-Credential: <PSCredential>
Use credential to access the AdminServer. You can use "-Credential (Get-Credential)" or "-Credential (Get-WLCredential)" To use Get-WLCredential you need run New-WLCredentials command to secure and store credentials in your profile.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false
-SuspendOnly: <SwitchParameter>
It only suspends the server without stopping it.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false
-TimeoutSec: <Int32>
Period of time in seconds that will be allowed to elapse in adminserver before the event is to take place.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named
30
false
false
-Force: <SwitchParameter>
Force the server to stop. If using this parameter the server will wait for the closing of all the active sessions.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false
-Throttling: <Int32>
It regulates the number of objects that will be executed in parallel.

Required?
Position?
Default value
Accept pipeline input?
Accept wildchard characters?

false
named

false
false

Inputs

Outputs

Examples

Example 1

Get-WLServer -AdminServer wls01.local.com | Stop-WLServer -Throttling 2

Output

Stop  managed servers on wls01.local.com domain. Two at a time.
This example use adminserver information from pipe and default credential previously stored with 'default' alias name.

Example 2

Get-WLCluster -AdminServer wls01.local.com -Name cluster01 | Stop-WLServer

Output

Stop all managed servers on weblogic cluster 'cluster01'.
This example use adminserver information from pipe and default credential previously stored with 'default' alias name.

About psWeblogic

Get-WLCacheIndex

Synopsis

Syntax

Description

Parameters

Inputs

Outputs

Examples

RelatedLinks

Notes

Get-WLChangeManager

Synopsis

Syntax

Description

Parameters

Inputs

Outputs

Examples

RelatedLinks

Notes

Get-WLCluster

Synopsis

Syntax

Description

Parameters

Inputs

Outputs

Examples

RelatedLinks

Notes

Get-WLCredential

Synopsis

Syntax

Description

Parameters

Inputs

Outputs

Examples

RelatedLinks

Notes

Get-WLDatasource

Synopsis

Syntax

Description

Parameters

Inputs

Outputs

Examples

RelatedLinks

Notes

Get-WLDeployment

Synopsis

Syntax

Description

Parameters

Inputs

Outputs

Examples

RelatedLinks

Notes

Get-WLDomain

Synopsis

Syntax

Description

Parameters

Inputs

Outputs

Examples

RelatedLinks

Notes

Get-WLEnvironment

Synopsis

Syntax

Description

Parameters

Inputs

Outputs

Examples

RelatedLinks