H ascrsctl Online Help

The detailed usage of ascrsctl can be obtained by following the instructions generated from the command ascrsctl help. This appendix provides the full content of the help pages to serve as a complete offline reference.

H.1 create/as

TOPIC

create/as - create as ASCRS resource

COMMAND

ascrsctl create -name <string> -type as -componentHome <string>
            [-componentIDs <string> [<string> ...]]
            -vip <string> -disk <string> [<string> ...]
            [-db <string> [<string> ...]]
            [-as <string> [<string> ...]]
            [options]

DESCRIPTION

This ASCRS command is used to create (or register) a WebLogic Administration Server resource in CRS.

These are mandatory arguments:

-name, -n

This argument specifies the resource name to be created.

-type, -t

This argument specifies the resource type. Its value must be as.

-componentHome, -ch

This argument specifies the location of WebLogic domain that contains the targeted Administration Server, managed servers, or the OPMN managed servers.

-vip

This argument specifies the virtual IP resource the WebLogic Administration Server depends upon.

-disk

This argument specifies the shared disks hosting the WebLogic software, the Administration Server domain directory and other shared disks this resource directly depends upon. If a shared disk is used for multiple purposes, it needs to be specified only once. The value for this parameter is a space or comma-separated list of ASCRS disk resource names.

The other non-mandatory options:

db

This argument specifies the database resources this as resource directly depends upon.

as

This argument specifies the as resources this resource directly depends upon.

-clusterNodes, -nodes, -cn

This argument specifies the valid nodes of the cluster across which the resource can failover. The value is a space or comma-separated subset of (or all) nodes of a cluster. If it is not specified, all nodes are included.

-resourceParams, -params, -p

This argument specifies a string of comma separated name value pairs to set CRS configuration for a specific resource, for example, as=1, rt=400.

The property names and their value ranges are listed in Table H-1. Except for as, st and ra, all the other numbers are in seconds. These properties can be configured through the ASCRS configuration file.

If a property is neither configured nor specified with this option, the default is assumed.

Table H-1 Resource Values

Parameter Min Max Default Purpose

as

0

1

1

Auto Start

ci

5

6000

600

Check Interval

fd

5

600

50

Failover Delay

fi

5

6000

50

Failure Interval

ft

0

20

5

Failure Threshold

ra

0

20

3

Restart Attempts

st

20

3600

30

Script Timeouts

rt

20

3600

30

Start Timeout

pt

20

3600

30

Stop Timeout

-policy

This argument specifies what resource parameter values are used. These policies and values are available in the ASCRS configuration file.

The valid values are normal or fast. If it not specified normal is assumed. However, the -resourceParams values always take precedence over the policy.

EXAMPLE(S)

ascrsctl create -n idm.weblogic -t as 
          -ch /sharedisk/fmw/user_projects/domains/IDMDomain
          -vip idmvip -disk idmdisk 
 
ascrsctl create -n idm.weblogic -t as 
          -ch /sharedisk/fmw/user_projects/domains/IDMDomain
          -vip idmvip -disk idmdisk -p st=800,rt=800,pt=800
 
ascrsctl create -n idm.opmn -t as 
          -ch /sharedisk/fmw/asinst_1
          -vip idmvip -disk idmdisk -p st=800,rt=800,pt=800

H.2 create/db

TOPIC

create/db - create db ASCRS resource

COMMAND

ascrsctl create -name <string> -type db -oraHomestring>
            -oraSID <string> -disk <string> [<string> ...]
            -lsnr <string> [-pfile <string>] [options]

DESCRIPTION

This ASCRS command is used to create (or register) an Oracle database resource in CRS.

These are mandatory arguments:

-name, -n

This argument specifies the resource name to be created.

-type, -t

This argument specifies the resource type. Its value must be db.

-oraHome, -oh

This argument specifies the database Oracle Home location.

-oraSID, -sid

This argument specifies the Oracle SID name.

-disk

This argument specifies the shared disks hosting the Oracle Home and data files. The value for this parameter is a space or comma-separated list of ASCRS disk resource names.

-lsnr

This argument specifies the listener resource used by this database.

The other non-mandatory options:

-clusterNodes, -nodes, -cn

This argument specifies the valid nodes of the cluster across which the resource can failover.

The value is a space or comma-separated subset of (or all) nodes of a cluster. If it is not specified, all the nodes are included.

-resourceParams, -params, -p

This argument specifies a string of comma separated name value pairs to set CRS configuration for a specific resource, for example, as=1,rt=400.

The property names and their value ranges are listed in Table H-1. Except for as, st and ra, all the other numbers are in seconds. These properties can be configured through the ASCRS configuration file.

-policy

This argument specifies what resource parameter values are used. These policies and values are available in the ASCRS configuration file.

The valid values are normal or fast. If it not specified normal is assumed. However, the -resourceParams values always take precedence over the policy.

-pfile, -pf

This argument specifies the database pfile for starting the database.

EXAMPLE(S)

ascrsctl create -n mydb -t db -oh /cfcdb1 -sid orcl
          -disk ohdisk datafiledisk -lsnr mydblsnr

H.3 create/dnlsnr

TOPIC

create/dnlsnr - create dblsnr ASCRS resource

COMMAND

ascrsctl create -name <string> -type dblsnr -listenerName <string>
          -listenerOracleHome <string> 
          -vip <string> -disk <string> 
          [-tnsAdmin <string>] [options]

DESCRIPTION

This ASCRS command is used to create (or register) an Oracle database listener resource in CRS.

These are mandatory arguments:

-name, -n

This argument specifies the resource name to be created.

-type, -t

This argument specifies the resource type. Its value must be dblsnr.

-listnerOracleHome, -lsnroh, -loh

This argument specifies the Oracle Home of the database that owns this listener.

-vip

This argument specifies the vip resource this listener runs on.

-disk

This argument specifies the disk resource the Oracle Home resides on.

-lsnr

This argument specifies the listener resource used by this database.

The other non-mandatory options:

-clusterNodes, -nodes, -cn

This argument specifies the valid nodes of the cluster across which the resource can failover.

The value is a space or comma-separated subset of (or all) nodes of a cluster. If it is not specified, all the nodes are included.

-resourceParams, -params, -p

This argument specifies a string of comma separated name value pairs to set CRS configuration for a specific resource, for example, as=1,rt=400.

The property names and their value ranges are listed in Table H-1. Except for as, st and ra, all the other numbers are in seconds. These properties can be configured through the ASCRS configuration file.

-policy

This argument specifies what resource parameter values are used. These policies and values are available in the ASCRS configuration file.

The valid values are normal or fast. If it not specified normal is assumed. However, the -resourceParams values always take precedence over the policy.

-tnsAdmin, -ta

This argument specifies the location of the listener configuration if it is not in the default location within the Oracle Home.

EXAMPLE(S)

ascrsctl create -name mydblsnr -type dblsnr -listenerName orcl
           -listenerOracleHome /cfcdb1
           -vip 192.168.1.10 -disk ohdisk

H.4 create/disk

TOPIC

create/disk - create disk ASCRS resource

COMMAND

ascrsctl create -name <string> -type disk -path <string>
          -mountCommand <string> -umountCommand <string>
          [options]

DESCRIPTION

This ASCRS command is used to create (or register) a shared disk resource in CRS. To successfully create a disk resource, a signature file needs to be created on the root of the shared disk. See the Oracle Fusion Middleware Administrator's Guide for details.

These are mandatory arguments:

-name, -n

This argument specifies the resource name to be created.

-type, -t

This argument specifies the resource type. Its value must be disk.

path

This argument specifies the mount point of the shared disk.

-mountCommand, -mc

This argument specifies a platform specific command to be invoked when mounting the shared disk. Command "nop" takes no action.

-umountCommand, -umc

This argument specifies a platform specific command to be invoked when unmounting the shared disk. Command "nop" takes no action.

The other non-mandatory options:

-clusterNodes, -nodes, -cn

This argument specifies the valid nodes of the cluster across which the resource can failover.

The value is a space or comma-separated subset of (or all) nodes of a cluster. If it is not specified, all the nodes are included.

-resourceParams, -params, -p

This argument specifies a string of comma separated name value pairs to set CRS configuration for a specific resource, for example, as=1,rt=400.

The property names and their value ranges are listed in Table H-1. Except for as, st and ra, all the other numbers are in seconds. These properties can be configured through the ASCRS configuration file.

-policy

This argument specifies what resource parameter values are used. These policies and values are available in the ASCRS configuration.

The valid values are normal or fast. If it not specified normal is assumed. However, the -resourceParams values always take precedence over the policy.

EXAMPLE(S)

ascrsctl create -n dbhome -t disk -path /cfcdb1
           -mc "/bin/mount /dev/sda1 /cfcdb1" -p fd=30
ascrsctl create -n dbhome -t disk -path /cfcdb1
           -mc "/bin/mount /dev/sda1 /cfcdb1"
           -umc "/bin/umount /dev/sda1"

H.5 create/vip

TOPIC

create/vip - create vip ASCRS resource

COMMAND

ascrsctl create -name <string> -type vip -ipAddr <ip> -netmask
                  <string> -interface <string> [options]

DESCRIPTION

This ASCRS command is used to create (or register) a virtual IP resource in CRS

These are mandatory arguments:

-name, -n

This argument specifies the resource name to be created.

-type, -t

This argument specifies the resource type. Its value must be vip.

-ipAddr, -ip

This argument specifies the IP address of the virtual IP or its hostname.

-netmask, -nm

This argument specifies the network mask with the above virtual IP.

-interface, -if

This argument specifies the network interface(s) on which the IP should be enabled.

The value can be one or more interface names such as eth0 or "eth0|eth1".

The other non-mandatory options:

-clusterNodes, -nodes, -cn

This argument specifies the valid nodes of the cluster across which the resource can failover.

The value is a space or comma-separated subset of (or all) nodes of a cluster. If it is not specified, all the nodes are included.

-resourceParams, -params, -p

This argument specifies a string of comma separated name value pairs to set CRS configuration for a specific resource, for example, as=1,rt=400.

The property names and their value ranges are listed in Table H-1. Except for as, st and ra, all the other numbers are in seconds. These properties can be configured through the ASCRS configuration file.

-policy

This argument specifies what resource parameter values are used. These policies and values are available in the ASCRS configration file.

The valid values are normal or fast. If it not specified normal is assumed. However, the -resourceParams values always take precedence over the policy.

EXAMPLE(S)

ascrsctl create -n myvip -t vip -ip 192.168.1.10 -nm 255.255.255.0
           -if eth1 -p ci=5

H.6 delete

TOPIC

delete - delete an ASCRS resource

COMMAND

ascrsctl delete -name <string> [-type <string>] [-noprompt]

DESCRIPTION

This ASCRS command is used to delete a resource created with ASCRS. Once a resource is successfully deleted, the resource is no longer managed by CRS.

An ASCRS resource cannot be deleted if there are still other resource(s) depending on it or if it is not in the offline state.

These are mandatory arguments:

-name, -n

This argument specifies the resource name.

Non-mandatory arguments:

-type, -t

This argument specifies the resource type if the resource name is in short form. It is not needed if the name is in canonical form.

-noprompt, -np

When specified, the user is not prompted for confirmation.

EXAMPLE(S)

ascrsctl delete -n mydisk -np
ascrsctl delete -n ora.myvip.cfcvip

H.7 start

TOPIC

start - start an ASCRS resource

COMMAND

ascrsctl start -name <string> [-type <string>] [-node <string>]

DESCRIPTION

This ASCRS command is used to start a resource already created with ASCRS.

These are mandatory arguments:

-name, -n

This argument specifies the resource name.

Optional arguments:

-type, -t

This argument specifies the resource type if the resource name is in short form. It is not needed if the name is in canonical form.

-node

This argument specifies the cluster node for starting the resource. If it is not specified, the node is chosen by CRS based on the placement policy of this resource

EXAMPLE(S)

ascrsctl start -n mydisk -t disk
ascrsctl start -n ora.myvip.cfcvip -node hostA.mycompany.com

H.8 status

TOPIC

status - check the status of ASCRS resources

COMMAND

ascrsctl status [-name <string>] [-type <string>] [-long]

DESCRIPTION

This ASCRS command is used to check the status of one or all resources created with ASCRS. The status of a resource includes its current running state, its basic CRS profile information, and its relationship to the other ASCRS resources.

-name, -n

This argument specifies the resource name. If not specified, check all resources.

-type, -t

This argument specifies the resource type if the resource name is in short form. It is not needed if the name is in canonical form.

-long, -l

If specified, the status information is displayed in a detailed format.

EXAMPLE(S)

ascrsctl status
ascrsctl status -name ora.mydisk.cfcdisk 
ascrsctl status -l

H.9 stop

TOPIC

stop - stop an ASCRS resource

COMMAND

ascrsctl stop -name <string> [-type <string>] [-force] [-noprompt]

DESCRIPTION

This ASCRS command is used to stop a resource created with ASCRS.

Mandatory arguments:

-name, -n

This argument specifies the resource name.

Non-mandatory arguments:

-type, -t

This argument specifies the resource type if the resource name is in short form. It is not needed if the name is in canonical form.

-force, -f

This argument shuts down the named resource and takes it offline from CRS management. This option guarantees to take offline the CRS monitoring of the resource, but does not guarantee to shut down the resource if it is already in an unmanageable state.

-noprompt, -np

When specified, the user is not prompted for confirmation, and the resource and its dependents are taken offline.

EXAMPLE(S)

ascrsctl stop -n mydisk -t disk
ascrsctl stop -n ora.myvip.cfcvip -f -np

H.10 switch

TOPIC

switch - switchover an ASCRS resource to another cluster node

COMMAND

ascrsctl switch -name <string> [-type <string>]
         [-node <string>]  [-force] [-noprompt]

DESCRIPTION

This ASCRS command is used to switch over an ASCRS resource that is currently in the online state to another node in the cluster. All resources this resource depends upon are also switched over.

Mandatory arguments:

-name, -n

This argument specifies the resource name.

Non-mandatory arguments:

-type, -t

This argument specifies the resource type if the resource name is in short form. It is not needed if the name is in canonical form.

-node

This argument specifies the target node of this resource. If it is not specified, the target node is chosen by CRS based on the placement policy of this resource.

-noprompt, -np

When specified, the user is not prompted for confirmation.

EXAMPLE(S)

ascrsctl switch -n mydisk -t disk hostB.mycompany.com
ascrsctl switch -n ora.myvip.cfcvip -np

H.11 update/as

TOPIC

update/as - update as ASCRS resource

COMMAND

ascrsctl update -name <string> [-type as] [-componentHome <string>]
           [-componentIDs <string> [<string> ...]]
            [-vip <string>] [-disk <string> [<string> ...]]
            [-db <string> [<string> ...]]
            [-as <string> [<string> ...]]
            [options]

DESCRIPTION

This ASCRS command is used to update an as resource created with ASCRS.

Mandatory arguments:

-name, -n

This argument specifies the resource name to be updated.

Non-mandatory arguments:

-type, -t

This argument specifies the resource type and its value must be as. If the resource name is in canonical form, -type option can be omitted.

-componentHome, -ch

This argument specifies the location of the WebLogic domain or OPMN AS instance home.

-componentIDs, -ci

This argument specifies the names of the servers to be managed in the WebLogic domain, or the OPMN instance. Value 'all' means all the server names are included.

-vip

This argument specifies the virtual IP resource this component depends upon.

-disk

This argument specifies the shared disk resources this as resource directly depends upon. The value is a space or comma-separated list of disk resource names.

-db

This argument specifies the database resources this as resource directly depends upon. Value 'nil' removes all these dependencies.

-as

This argument specifies the as resources this resource directly depends upon. Value 'nil' removes all these dependencies.

-clusterNodes, -nodes, -cn

This argument specifies the valid nodes of the cluster across which the resource can failover.

The value is a comma or space-separated subset of at least two nodes of the cluster. The special value default will include all the nodes.

-resourceParams, -params, -p

This argument specifies a string of comma separated name value pairs to set CRS configuration for a specific resource, for example, as=1, rt=400.

The property names and their value ranges are listed in Table H-1. Except for as, st and ra, all the other numbers are in seconds. These properties can be configured through the ASCRS configuration file.

EXAMPLE(S)

ascrsctl update -n myas -t as -vip newvip -disk instdisk wldisk
ascrsctl update -n ora.myas.cfcas -p st=800,rt=800,pt=800

H.12 update/db

TOPIC

update/as - update as ASCRS resource

COMMAND

ascrsctl update -name <string> -type db [-oraHome <string>]
          [-oraSID <string>] [-disk <string> [<string> ...]]
          [-lsnr <string>] [-pfile <string>] [options]

DESCRIPTION

This ASCRS command is used to update an ASCRS db resource registered in CRS.

Mandatory arguments:

-name, -n

This argument specifies the resource name to be updated.

Non-mandatory arguments:

-type, -t

This argument specifies the resource type and its value must be db. If the resource name is in canonical form, -type option can be omitted.

-oraHome, -oh

This argument specifies the database Oracle Home location.

-oraSID, -sid

This argument specifies the Oracle SID name

-disk

This argument specifies the shared disk resources this as resource directly depends upon. The value is a space or comma-separated list of disk resource names.

lsnr

This argument specifies the listener resource.

The other non-mandatory options:

-clusterNodes, -nodes, -cn

This argument specifies the valid nodes of the cluster across which the resource can failover.

The value is a comma or space-separated subset of at least two nodes of the cluster. The special value default will include all the nodes.

-resourceParams, -params, -p

This argument specifies a string of comma separated name value pairs to set CRS configuration for a specific resource, for example, as=1, rt=400.

The property names and their value ranges are listed in Table H-1. Except for as, st and ra, all the other numbers are in seconds. These properties can be configured through the ASCRS configuration file.

-pfile, -pf

This argument specifies the database pfile for starting the database. The special value default will unset the its current value.

EXAMPLE(S)

ascrsctl update -n ora.mydb.cfcdb -disk ohdisk -lsnr newlsnr
            -p st=60,rt=60,pt=60

H.13 update/dblsnr

TOPIC

update/dblsnr - update dblsnr ASCRS resource

COMMAND

ascrsctl update -name <string> [-type dblsnr]
           [-listenerName <string>]
           [-listenerOracleHome <string>] 
           [-vip <string>] [-disk <string>] 
           [-tnsAdmin <string>] [options]

DESCRIPTION

This ASCRS command is used to update a dblsnr resource created with ASCRS.

Mandatory arguments:

-name, -n

This argument specifies the resource name to be updated. If it is fully qualified name, -type option can be omitted.

Non-mandatory arguments:

-type, -t

If specified, must be dblsnr.

-lisnerName, -ln

This argument specifies the database listener name.

-listnerOracleHome, -lsnroh, -loh

This argument specifies the Oracle Home of the database that owns this listener.

-vip

This argument specifies the vip resource this listener runs on.

-clusterNodes, -nodes, -cn

This argument specifies the valid nodes of the cluster across which the resource can failover.

The value is a comma or space-separated subset of at least two nodes of the cluster. The special value default includes all the nodes.

-resourceParams, -params, -p

This argument specifies a string of comma separated name value pairs to set CRS configuration for a specific resource, for example, as=1, rt=400.

The property names and their value ranges are listed in Table H-1. Except for as, st and ra, all the other numbers are in seconds. These properties can be configured through the ASCRS configuration file.

-tnsAdmin, -ta

This argument specifies the new location of the listener configuration file. The special value default will unset its current value.

-disk

This argument specifies the disk resource the Oracle Home resides on.

EXAMPLE(S)

ascrsctl update -n mydblsnr -t dblsnr -vip newvip
ascrsctl update -n mydblsnr -t dblsnr -disk newdisk -p st=30,pt=40,rt=40

H.14 update/disk

TOPIC

update/disk - update disk ASCRS resource

COMMAND

ascrsctl update -name <string> [-type disk] [-path <string>]
          [-mountCommand <string>] [-umountCommand <string>]
          [options]

DESCRIPTION

This ASCRS command is used to update a disk resource created with ASCRS.

Mandatory arguments:

-name, -n

This argument specifies the resource name to be updated. If it is fully qualified name, -type option can be omitted.

Non-mandatory arguments:

-type, -t

If specified, must be disk.

-path

This argument specifies the mount point of the shared disk.

-mountCommand, -mc

This argument specifies a platform specific fully qualified command or script name be executed for mounting the shared disk.

-umountCommand, -umc

This argument specifies a platform specific fully qualified command or script name be executed for unmounting the shared disk.

-clusterNodes, -nodes, -cn

This argument specifies the valid nodes of the cluster across which the resource can failover.

The value is a comma or space-separated subset of at least two nodes of the cluster. The special value default includes all nodes.

-resourceParams, -params, -p

This argument specifies a string of comma separated name value pairs to set CRS configuration for a specific resource, for example, as=1, rt=400.

The property names and their value ranges are listed in Table H-1. Except for as, st and ra, all the other numbers are in seconds. These properties can be configured through the ASCRS configuration file.

EXAMPLE(S)

ascrsctl update -n mydisk -t disk -umfc "/bin/umount -l /sharedisk"

H.15 update/vip

TOPIC

update/vip - update vip ASCRS resource

COMMAND

ascrsctl update -name <string> [-type vip] [-ipAddr <string>
          [-netmask <string>] [-interface <string>] [options]

DESCRIPTION

This ASCRS command is used to update a vip resource created with ASCRS.

Mandatory arguments:

-name, -n

This argument specifies the resource name to be updated. If it is fully qualified name, -type option can be omitted.

Non-mandatory arguments:

-type, -t

If specified, must be vip.

-ipAddr, -ip

This argument specifies the IP address of the virtual IP or its hostname.

-netmask, -nm

This argument specifies the network mask with the above virtual IP.

-umountCommand, -umc

This argument specifies a platform specific fully qualified command or script name be executed for unmounting the shared disk.

-interface, -if

This argument specifies the network interface on which the IP should be enabled.

Value can be one or more interface names such as eth0 or "eth0|eth1".

-clusterNodes, -nodes, -cn

This argument specifies the valid nodes of the cluster across which the resource can failover.

The value is a comma or space-separated subset of at least two nodes of the cluster. The special value default includes all nodes.

-resourceParams, -params, -p

This argument specifies a string of comma separated name value pairs to set CRS configuration for a specific resource, for example, as=1, rt=400.

The property names and their value ranges are listed in Table H-1. Except for as, st and ra, all the other numbers are in seconds. These properties can be configured through the ASCRS configuration file.

EXAMPLE(S)

ascrsctl update -n ora.myvip.cfcvip -ip 192.168.1.10
ascrsctl update -n ora.myvip.cfcvip -if eth1 -p ci=3