Skip to content

Commit

Permalink
(#11769) New workshop from the DBA Essentials series - Configure netw…
Browse files Browse the repository at this point in the history 
…ork env for 23ai (#695)

Hello,

We have developed a new workshop - Configure network environment for Oracle Database 23ai, WMS ID is #11769.

Oracle Database 23ai (23.6) GA was Oct 15, Tue. Therefore, to compliment the database release, we would like to publish our workshops from the DBA Essentials series for 23ai.
Would be great if you approve this PR please so that we could proceed with publishing to production on priority.
Remaining workshops from the series would follow suit and we intend to publish them all in the next 2 weeks.

Thanks a lot for your help and support.

~mg
  • Loading branch information
@manish-garodia
manish-garodia authored Oct 18, 2024
1 parent b87f3f1 commit fafff37
Show file tree
Hide file tree
Showing 13 changed files with 926 additions and 0 deletions.
368 changes: 368 additions & 0 deletions ...ai-ws3-configure-network-env/administer-listener-ops/administer-listener-ops.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,368 @@
# Administer listener operations

## Introduction

This lab shows how to perform listener operations, such as starting and stopping the listener, checking listener status, and so on. It also shows how to access listener control utility and view details of the listener.

Estimated time: 10 minutes

### Objectives

- Set environment variables
- View listener configuration and status
- Stop the listener
- Start the listener
- Access the Listener Control utility

> **Note**: [](include:example-values)
### Prerequisites

This lab assumes you have -

- An Oracle Cloud account
- Completed all previous labs successfully

## Task 1: Set environment variables

[](include:set-env-var)

> **Tip**: If you have reserved a Livelabs sandbox environment, then you can run `/usr/local/bin/.set-env-db.sh` and enter the corresponding number for the `$ORACLE_SID`. It sets the environment variables automatically.
## Task 2: View listener configuration

In this task, you will check whether the listener is up and running and view listener configuration. 

1. From `$ORACLE_HOME/bin`, run `lsnrctl status`. 

```
$ <copy>./lsnrctl status</copy>
```

## Output

This command displays listener configuration and status.

```
LSNRCTL for Linux: Version 23.0.0.0.0 - Production on 07-AUG-20XX 12:09:46

Copyright (c) 1991, 2024, Oracle. All rights reserved.

Connecting to (DESCRIPTION=(ADDRESS=(PROTOCOL=TCP)(HOST=localhost.example.com)(PORT=1523)))
STATUS of the LISTENER
------------------------
Alias LISTENER
Version TNSLSNR for Linux: Version 23.0.0.0.0 - Production
Start Date 07-JUL-20XX 10:38:25
Uptime 31 days 1 hr. 31 min. 21 sec
Trace Level off
Security ON: Local OS Authentication
SNMP OFF
Listener Parameter File /u01/app/oracle/product/23.4.0/dbhome_1/network/admin/listener.ora
Listener Log File /u01/app/oracle/diag/tnslsnr/localhost/listener/alert/log.xml
Listening Endpoints Summary...
(DESCRIPTION=(ADDRESS=(PROTOCOL=tcp)(HOST=localhost.example.com)(PORT=1523)))
(DESCRIPTION=(ADDRESS=(PROTOCOL=ipc)(KEY=EXTPROC1523)))
Services Summary...
Service "16dbed12d9b5bd08e0631fc45e640b06.us.oracle.com" has 1 instance(s).
Instance "orcl", status READY, has 1 handler(s) for this service...
Service "1ca6f267eae900bfe0638e084664e079.us.oracle.com" has 1 instance(s).
Instance "orcl", status READY, has 1 handler(s) for this service...
Service "orcl.us.oracle.com" has 1 instance(s).
Instance "orcl", status READY, has 1 handler(s) for this service...
Service "orclXDB.us.oracle.com" has 1 instance(s).
Instance "orcl", status READY, has 1 handler(s) for this service...
Service "orclpdb.us.oracle.com" has 1 instance(s).
Instance "orcl", status READY, has 1 handler(s) for this service...
The command completed successfully
```

> The listener control utility displays a summary of listener configuration settings, listening protocol addresses, and the services registered with the listener.

If your Oracle Database contains PDBs, then the status displays a service for each PDB running on the database instance.

## Task 3: Stop and start the listener

The listener runs automatically when the host system starts. If a problem occurs in the system or if you manually stop the listener, then you can start the listener again from the command line. 

In this task, you will learn how to stop and start the listener.

1. From `$ORACLE_HOME/bin`, stop the listener first, if it is already running. 

```
$ <copy>./lsnrctl stop</copy>
```

## Output

```
LSNRCTL for Linux: Version 23.0.0.0.0 - Production on 07-AUG-20XX 12:29:46

Copyright (c) 1991, 2024, Oracle. All rights reserved.

Connecting to (DESCRIPTION=(ADDRESS=(PROTOCOL=TCP)(HOST=localhost.example.com)(PORT=1523)))
The command completed successfully
```

Now that you have stopped the listener, run the following to check if you can still connect to your Oracle Database.

1. From `$ORACLE_HOME/bin`, log in to SQL Plus as the *SYSTEM* user using the service name *orcl*.

```
$ <copy>./sqlplus system@orcl</copy>
```

## Output

```
SQL*Plus: Release 23.0.0.0.0 - Production on 07-AUG-20XX 12:35:46 2024
Version 23.4.0.24.05

Copyright (c) 1982, 2024, Oracle. All rights reserved.

Enter password:
```

1. When prompted for password, enter the administrative password for your Oracle Database, for example *We!come1*.

```
ERROR:
ORA-12541: Cannot connect. No listener at host 0.0.0.0 port 1523.
Help: https://docs.oracle.com/error-help/db/ora-12541/
```

The error indicates that the listener is not running.

> **Note**: If the listener is not running on the host when Oracle Enterprise Manager (Oracle EM) tries to establish connection with your Oracle Database, then it returns an I/O error indicating failure.

Exit the prompt by pressing **Ctrl + C** followed by **Enter**. 

1. Start the listener again from the $ORACLE_HOME/bin directory.

```
$ <copy>./lsnrctl start</copy>
```

## Output

```
LSNRCTL for Linux: Version 23.0.0.0.0 - Production on 07-AUG-20XX 12:40:31

Copyright (c) 1991, 2024, Oracle. All rights reserved.

Starting /u01/app/oracle/product/23.4.0/dbhome_1/bin/tnslsnr: please wait...

TNSLSNR for Linux: Version 23.0.0.0.0 - Production
System parameter file is /u01/app/oracle/product/23.4.0/dbhome_1/network/admin/listener.ora
Log messages written to /u01/app/oracle/diag/tnslsnr/localhost/listener/alert/log.xml
Listening on: (DESCRIPTION=(ADDRESS=(PROTOCOL=tcp)(HOST=localhost.example.com)(PORT=1523)))
Listening on: (DESCRIPTION=(ADDRESS=(PROTOCOL=ipc)(KEY=EXTPROC1523)))

Connecting to (DESCRIPTION=(ADDRESS=(PROTOCOL=TCP)(HOST=localhost.example.com)(PORT=1523)))
STATUS of the LISTENER
------------------------
Alias LISTENER
Version TNSLSNR for Linux: Version 23.0.0.0.0 - Production
Start Date 07-AUG-20XX 12:40:31
Uptime 0 days 0 hr. 0 min. 0 sec
Trace Level off
Security ON: Local OS Authentication
SNMP OFF
Listener Parameter File /u01/app/oracle/product/23.4.0/dbhome_1/network/admin/listener.ora
Listener Log File /u01/app/oracle/diag/tnslsnr/localhost/listener/alert/log.xml
Listening Endpoints Summary...
(DESCRIPTION=(ADDRESS=(PROTOCOL=tcp)(HOST=localhost.example.com)(PORT=1523)))
(DESCRIPTION=(ADDRESS=(PROTOCOL=ipc)(KEY=EXTPROC1523)))
The listener supports no services
The command completed successfully
```

You have started the listener on the host again.

> **Note**: To access Oracle Database, the listener must be up and running. 

1. View listener status as explained in the previous task.

```
$ <copy>./lsnrctl status</copy>
```

The status displays that the listener service is running.

1. Check whether you can log in to SQL Plus as *SYSTEM* using the password and service name.
For this lab, the password is *We!come1* and the service name is *orcl*.

```
$ <copy>./sqlplus system/We!come1@orcl</copy>
```

## Output

```
SQL*Plus: Release 23.0.0.0.0 - Production on Wed Aug 7 12:42:33 20XX
Version 23.4.0.24.05

Copyright (c) 1982, 2024, Oracle. All rights reserved.

Last Successful login time: Sun Jul 07 20XX 10:41:17 +00:00

Connected to:
Oracle Database 23ai Enterprise Edition Release 23.0.0.0.0 - Production
Version 23.4.0.24.05

SQL>
```

You are connected to Oracle Database.

1. Exit from the SQL Prompt.

```
SQL> <copy>exit</copy>
```

You can also access the Listener Control utility and perform basic management functions on the listener.

## Task 4: Access the Listener Control utility

The Listener Control utility helps you to administer the listener.

In this task, you will access the Listener Control utility and run some listener commands.

1. From `$ORACLE_HOME/bin`, enter the `LSNRCTL` prompt.

```
$ <copy>./lsnrctl</copy>
```

```
LSNRCTL for Linux: Version 23.0.0.0.0 - Production on 07-AUG-20XX 12:45:25

Copyright (c) 1991, 2024, Oracle. All rights reserved.

Welcome to LSNRCTL, type "help" for information.

LSNRCTL>
```

1. View the commands that you can run from the `LSNRCTL` prompt.

```
LSNRCTL> <copy>HELP</copy>
```

```
The following operations are available
An asterisk (*) denotes a modifier or extended command:

start stop status services
servacls version reload save_config
trace spawn quit exit
set* show*
```

You can run these commands from the Listener Control utility to view and manage the listener settings.

1. Enter `HELP` with a command name to view the complete syntax and additional information about the Listener Control utility command, for example *`trace`*.

```
LSNRCTL> <copy>HELP trace</copy>
```

```
trace OFF | USER | ADMIN | SUPPORT [<listener_name>] : set tracing to the specified level
```

1. View the parameters of the listener.

```
LSNRCTL> <copy>SHOW</copy>
```

```
The following operations are available after show
An asterisk (*) denotes a modifier or extended command:

rawmode displaymode
rules trc_file
trc_directory trc_level
log_file log_directory
log_status stats
current_listener inbound_connect_timeout
startup_waittime snmp_visible
save_config_on_stop dynamic_registration
enable_global_dynamic_endpoint oracle_home
pid connection_rate_limit
valid_node_checking_registration registration_invited_nodes
registration_excluded_nodes remote_registration_address
allow_multiple_redirects all
```

1. Check the name of the current listener.

```
LSNRCTL> <copy>SHOW CURRENT_LISTENER</copy>
```

```
Current Listener is LISTENER
```

1. Check the version of listener control utility.

```
LSNRCTL> <copy>VERSION</copy>
```

```
Connecting to (DESCRIPTION=(ADDRESS=(PROTOCOL=TCP)(HOST=localhost.example.com)(PORT=1523)))
TNSLSNR for Linux: Version 23.0.0.0.0 - Production
TNS for Linux: Version 23.0.0.0.0 - Production
Unix Domain Socket IPC NT Protocol Adaptor for Linux: Version 23.0.0.0.0 - Production
Oracle Bequeath NT Protocol Adapter for Linux: Version 23.0.0.0.0 - Production
TCP/IP NT Protocol Adapter for Linux: Version 23.0.0.0.0 - Production,,
The command completed successfully
```

1. View statistics about the number of registration commands that the listener receives while handling client connection requests.

```
LSNRCTL> <copy>SHOW STATS -REG</copy>
```

```
Connecting to (DESCRIPTION=(ADDRESS=(PROTOCOL=TCP)(HOST=localhost.example.com)(PORT=1523)))
------------------------
Global Level:
Recent
Recent Duration: 15 days 23 hr. 9 min. 13 sec
Command Instance Service ENDP Handler INF
Registration 2 10 2 4 0
Updates 4246 0 0 6543 0
Re-Register 0 0 0 0 0
Un-Register 0 0 0 0 0
Cumulative
Registration 2 10 2 4 0
Updates 4246 0 0 6543 0
Re-Register 0 0 0 0 0
Un-Register 0 0 0 0 0
The command completed successfully
```

1. Exit from the Listener Control utility.

```
LSNRCTL> <copy>EXIT</copy>
```

> **Note**: You can use either `EXIT` or `QUIT` to exit from Listener Control utility.

Congratulations! You have successfully completed this workshop on *Network environment configuration for Oracle Database*. 

In this workshop, you learned how to check listener status, start and stop the listener, and view the commands of the Listener Control utility for your Oracle Database. 

## Acknowledgments

- **Author** - Manish Garodia, Database User Assistance Development
- **Contributors**: Binika Kumar, Bhaskar Mathur, Malai Stalin<if type="hidden">Suresh Rajan, Subhash Chandra, Dharma Sirnapalli, Subrahmanyam Kodavaluru</if>
- **Last Updated By/Date** - Manish Garodia, August 2024
1 change: 1 addition & 0 deletions ...ries-23ai/23ai-ws3-configure-network-env/intro-configure-network/files/example-values.txt
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
This lab contains system-specific values and paths. These details might vary depending on the system you are using.
Loading

0 comments on commit fafff37

Please sign in to comment.