List of asadmin commands

Scope: GlassFish v3 Release 2009
Author(s) : Kedar Mhaswade, Sreenivas Munnangi and others
State: Work in Progress

$Source: /cvs/glassfish/www/v3/admin/planning/j109/list-of-commands.html,v $

$Revision: 1.16 $

This list should be read in conjunction with admin CLI spec. This is the official list of commands that will be supported by GlassFish v3. This list does not contain the commands that may be created by module (read: GlassFish v3 module) for their own purpose. It only contains the commands that are supported by various GlassFish distributions. This forms the basis of documentation and QA work for GlassFish v3 admin CLI. Note that this document does not make definitive comments about distributions of GlassFish v3 and which commands are available where. Refer to distributions/packaging spec for the same. A command is a part of a module (GlassFish v3 module) and is available only if the module itself is available.

Please talk to authors if you want your command to be added to this list.

There are two main sections here. The existing commands (section I) are taken from GlassFish v2 and for their syntax, you should just refer to docs.sun.com for GlassFish v2, based on the name of the command. The new commands (section II) are fully specified here in terms of syntax and behavior. Some of the existing commands are being enhanced in this release and where this happens, it is clearly documented. Note that all commands are subject to the changed syntax (separation of asadmin options and command options) as documented in admin-cli.html. Note that this document does not cover the Shell Commands.

The commands are arranged with some relation to the modules. Unfortunately, not all ID's in the table below may be present. Readers are advised to refer to a command with ID against it. (This is mainly because it is still a work in progress).

Commands in this background-color were available in Prelude.

Existing Commands

Existing commands

Id

Name

Owner

Changes if Any

Notes

Core (admin)

 


 

 

1

start-domain

Byron/Siraj

Yes. We should provide additional startup Java parameters, to make it at par with "java -jar".

start-domain (in addition to other options, will have)

--javaoptions which lists the options to be sent to the domain's JVM on the startup. The options are separated by a ':'. These behave same as --debug in that they are not persisted to the domain.xml. They override any values from the domain.xml. For example,

start-domain --javaoptions -Xmx1g:-Xms1g domain1 will start the domain1 with the JVM having both minimum and maximum Java Heap Size as 1 GB, *even if* domain.xml says -Xmx512m -Xms512g.

The new --watchdog option will start a watchdog process that will listen for restart requests.

2

stop-domain

Byron/Siraj

 

 

133

restart-domain

Byron

 

Restart of a domain is supported if it was started with the watchdog option set to true.

7

generate-jvm-report

Kedar

 

 

9

version

Kedar/Byron

Yes. This command needs to be enhanced to serve the users much better.

The new syntax of this command is:

version [-v|--verbose] [-s|--spec] [-b|--bundle]

  1. Without any options, it describes the full product version along with the build-id.

  2. -s provides information of the specification version for various Java EE and other technologies. This is derived from the Specification-Version manifest attribute of various modules

  3. -b provides information of the OSGi bundles available to the server.

  4. -v provides all of the above.

If no server is running, you get this information locally. This does not change from the previous releases.

In the case of running server, it also provides the version of the Java it is running. This is a change from previous release.

10

add-resources

Jennifer

 

 

11

create-jvm-options

Kedar

 

 

12

delete-jvm-options

Kedar

 

 

13

create-lifecycle-module

Hong/Nachiappan

 

Jerome should comment.

14

delete-lifecycle-module

Hong/Nachiappan

 

Jerome should comment.

15

list-lifecycle-modules

Hong/Nachiappan

 

Jerome should comment.

16

create-profiler

Prashanth/Byron

 

 

17

delete-profiler

Prashanth/Byron

 

 

18

create-system-properties

Kedar

 

 

19

delete-system-property

Kedar

 

 

20

list-system-properties

Kedar

 

Add new command delete-system-properties to be consistent with create-system-property

21

create-threadpool

Nachiappan/Kedar

 

 

22

delete-threadpool

Nachiappan/Kedar

 

 

23

list-threadpools

Nachiappan/Kedar

 

 

24

get

Sreeni

 

 

25

set

Sreeni

 

 

26

list

Sreeni

 

 

27

verify-domain-xml

Nandini

 

 

28

change-admin-password

Kedar

 

 

Cli-Optional

(local)

Not all distributions of GlassFish would have these.


 

 

29

create-domain

Kedar

 

 

30

delete-domain

Kedar

 

 

31

list-domains

Kedar

 

 

32

start-database

Sreeni/Jennifer

 

 

33

stop-database

Sreeni/Jennifer

 

 

34

create-service

Byron

 

 

35

multimode

Kedar/Byron

 

 

36

backup-domain

Byron

 

 Low priority in current form

37

list-backups

Byron

 

 Low priority in current form

38

restore-domain

Byron

 

 Low priority in current form

39

login

Kedar

 

 

Common-Util

Logging etc.


 

 

40

display-error-distribution

Carla

 

Probably will be implemented. Carla is going to get back.

41

display-error-statistics

Carla

 

Probably will be implemented. Carla is going to get back.

42

display-log-records

Carla

 

Probably will be implemented. Carla is going to get back.

42a

rotate-log

Carla

 

 

Connectors

 


 

 

43

create-admin-object

Jennifer

 

 

44

delete-admin-object

Jennifer

 

 

45

list-admin-objects

Jennifer

 

 

46

create-connector-connection-pool

Jennifer

 

 

47

delete-connector-connection-pool

Jennifer

 

 

48

list-connector-connection-pools

Jennifer

 

 

49

create-connector-resource

Jennifer

 

 

50

delete-connector-resource

Jennifer

 

 

51

list-connector-resources

Jennifer

 

 

52

create-connector-security-map

Jennifer

 

 

53

delete-connector-security-map

Jennifer

 

 

54

update-connector-security-map

Jennifer

 

 

55

list-connector-security-maps

Jennifer

 

 

56

create-jms-host

Satish

 

 

57

delete-jms-host

Satish

 

 

58

list-jms-hosts

Satish

 

 

59

create-jms-resource

Satish

 

 

60

delete-jms-resource

Satish

 

 

61

list-jms-resources

Satish

 

 

62

create-jmsdest

Satish

 

 

63

delete-jmsdest

Satish

 

 

64

list-jmsdest

Satish

 

 

65

flush-jmsdest

Satish

 

 

66

create-resource-adapter-config

Jennifer

 

 

67

delete-resource-adapter-config

Jennifer

 

 

68

list-resource-adapter-configs

Jennifer

 

 

69

jms-ping

Satish

 

Need ping-resource as per Jagadish's spec.

Deployment

 


 

 

70

deploy

Hong

 

 

71

undeploy

Hong

 

 

72

enable

Hong/Jennifer

 

 

73

disable

Hong/Jennifer

 

 

74

deploydir

Hong

 

Deprecated; use deploy.

75

get-client-stubs

Tim

 

to check with Tim

76

list-components

Hong

 

 

77

list-sub-components

Hong

 

 

78

show-component-status

Hong

 

 

79

list-applications

Hong

 

Introduced in Prelude.

EJB

 


 

 

80

list-timers

Nachiappan

 

Ken has agreed to work on this.

JavaMail-Resource

 


 

 

81

create-javamail-resource

Nachiappan

 

 

82

delete-javamail-resource

Nachiappan

 

 

83

list-javamail-resources

Nachiappan

 

 

JDBC-Resource

 


 

 

84

create-jdbc-connection-pool

Jennifer

 

 

85

delete-jdbc-connection-pool

Jennifer

 

 

86

list-jdbc-connection-pools

Jennifer

 

 

87

create-jdbc-resource

Jennifer

 

 

88

delete-jdbc-resource

Jennifer

 

 

89

list-jdbc-resources

Jennifer

 

 

90

ping-connection-pool

Jennifer

 

 

JNDI Resource

 


 

 

91

create-custom-resource

Nachiappan

 

 

92

delete-custom-resource

Nachiappan

 

 

93

list-custom-resources

Nachiappan

 

 

94

create-jndi-resource

Nachiappan

 

 

95

delete-jndi-resource

Nachiappan

 

 

96

list-jndi-resources

Nachiappan

 

 

97

list-jndi-entries

Nachiappan

 

 

Transaction Service

 


 

 

98

freeze-transaction-service

Nachiappan

 

 

99

recover-transactions

Nachiappan

 

 

100

rollback-transaction

Nachiappan

 

 

101

unfreeze-transaction-service

Nachiappan

 

 

Monitoring

 


 

 

102

monitor (Related command: get --monitor)

Sreeni/Prashanth

 

 

102a

list-jndi-entries

Kedar

 

 

ORB

 


 

 

103

create-iiop-listener

Nachiappan

 

 

104

delete-iiop-listener

Nachiappan

 

 

105

list-iiop-listeners

Nachiappan

 

 

Security

 


 

 

106

change-master-password

Kedar

I have asked Security folks if we are supporting NSS and would need certutil etc. for this and similar command.

107

create-audit-module

Nandini

 

 

108

delete-audit-module

Nandini

 

 

109

list-audit-modules

Nandini

 

 

110

create-auth-realm

Nandini

 

 

111

delete-auth-realm

Nandini

 

 

112

list-auth-realms

Nandini

 

 

113

create-file-user

Nandini

 

 

114

delete-file-user

Nandini

 

 

115

update-file-user

Nandini

 

 

116

list-file-users

Nandini

 

 

117

list-file-groups

Nandini

 

 

118

create-message-security-provider

Nandini

 

 

119

delete-message-security-provider

Nandini

 

 

120

list-message-security-providers

Nandini

 

 

121

create-password-alias

Nandini

 

 

122

delete-password-alias

Nandini

 

 

123

update-password-alias

Nandini

 

 

124

list-password-aliases

Nandini

 

 

Web

 


 

 

125

create-ssl

Nandini

Refer to Grizzly Config specification.

I am thinking of deprecating these commands.

126

delete-ssl

Nandini

Refer to Grizzly Config specification.

I am thinking of deprecating these commands.

127

create-http-listener

Justin Lee

Refer to Grizzly Config specification.

 

128

delete-http-listener

Justin Lee

Refer to Grizzly Config specification.

 

129

list-http-listeners

Justin Lee

Refer to Grizzly Config specification.

 

130

create-virtual-server

Justin Lee

Refer to Grizzly Config specification.

 

131

delete-virtual-server

Justin Lee

Refer to Grizzly Config specification.

 

132

list-virtual-servers

Justin Lee

Refer to Grizzly Config specification.

 

 

Commands Introduced in GlassFish v3

Proposed Commands

Id

Complete Syntax

Notes

0

 

 

 

 

 

 

References