Virtual_Network_Vswitch_Query

Purpose

Use Virtual_Network_Vswitch_Query to obtain information about the specified virtual switch or switches.

Input Parameters

input_length

(int4) The total length of all input parameters (after this one).

function_name_length

(int4) Length of function_name – in this case, 29.

function_name

(string,29,char43) The API function name – in this case, 'Virtual_Network_Vswitch_Query'.

authenticated_userid_length

(int4) Length of authenticated_userid.

authenticated_userid

One of the following:

• (string,1-8,char42) The userid under whose authority to perform the function (AF_INET requests).
• (string,0-8,char42) The userid under whose authority to perform the function (AF_IUCV requests).

Note that authenticated_userid is optional for AF_IUCV requests. See Client Authentication for more information.

password_length

(int4) Length of password.

password

One of the following:

• (string,1-200,charNA) The password or passphrase to be used for authentication (AF_INET requests).
• (string,0-200,charNA) The password or passphrase to be used for authentication (AF_IUCV requests).

Note that password is optional for AF_IUCV requests. See Client Authentication for more information.

target_identifier_length

(int4) Length of target_identifier.

target_identifier

(string,1-8,char42) This must match an entry in the authorization file that also contains the authenticated_userid and the function_name (Virtual_Network_Vswitch_Query).

switch_name_length

(int4) Length of switch_name.

switch_name

One of the following:

• (string,1-8,char36 plus @#$_) The name of the new virtual switch.
• (string,1,*) All virtual switches.

Response 1 -- Immediate Request Verification

request_id

(int4) The identifier of the request.

Response 2 -- Output Parameters

output_length

(int4) The total length of all output parameters (after this one).

request_id

(int4) The identifier of the request (same as returned in immediate request verification above).

return_code

(int4) The return code.

reason_code

(int4) The reason code.

vswitch_array_length

(int4) Length of vswitch_array.

vswitch_array

(array) An array consisting of zero or more instances of vswitch_structure, as follows:

vswitch_structure

(structure) A structure consisting of one set of the following parameters:

vswitch_structure_length

(int4) The combined length of the remaining parameters in vswitch_structure (not including this parameter).

switch_name_length

(int4) Length of switch_name.

switch_name

One of the following:

• (string,1-8,char36 plus @#$_) The name of the virtual switch.
• (string,1,*) All virtual switches.

transport_type

(int1) The transport mechanism. The possible values are:

1

IP

2

Ethernet

port_type

(int1) The port type. The possible values are:

1

Access

2

Trunk

queue_memory_limit

(int4) The QDIO buffer size in megabytes.

routing_value

(int1) Indicates if the QDIO device will act as a router. The possible values are:

1

The device will not act as a router.

2

The device will act as a router.

vlan_id

(int4) The default VLAN ID. A value of 32768 indicates that the virtual switch was created as VLAN AWARE, without a default VLAN ID.

native_vlan_id

(int4) The native VLAN ID. A value of 32768 indicates that the virtual switch was created as VLAN AWARE, with a native VLAN ID of NONE.

mac_id

(int8) The MAC identifier.

gvrp_request_attribute

(int1) The attribute indicating if GVRP was requested. The possible values are:

1

GVRP requested

2

GVRP not requested

gvrp_enabled_attribute

(int1) The attribute indicating if GVRP is enabled. The possible values are:

1

GVRP enabled

2

GVRP not enabled

switch_status

(int1) The status of the virtual switch. The possible values are:

1

Virtual switch defined.

2

Controller not available.

3

Operator intervention required.

4

Disconnected.

5

Virtual devices attached to controller. Normally a transient state.

6

OSA initialization in progress. Normally a transient state.

7

OSA device not ready.

8

OSA device ready.

9

OSA devices being detached. Normally a transient state.

10

Virtual switch delete pending. Normally a transient state.

11

Virtual switch failover recovering. Normally a transient state.

12

Autorestart in progress. Normally a transient state.

real_device_array_length

(int4) Length of real_device_array.

real_device_array

(array) An array consisting of zero or more instances of real_device_structure, as follows:

real_device_structure

(structure) A structure consisting of one set of the following parameters:

real_device_structure_length

(int4) The combined length of the remaining parameters in real_device_structure (not including this parameter).

real_device_address

(int4) The real device address of the OSA-Express QDIO device.

controller_name_length

(int4) Length of controller_name.

controller_name

(string,0-71,char42 plus blank) The userid controlling the real device. This may be a maximum of eight userids, all 1-8 characters in length, delimited by blanks.

port_name_length

(int4) Length of port_name.

port_name

(string,0-16,char16) The port name.

device_status

(int1) The status of the real device. The possible values are:

0

Device is not active.

1

Device is active.

2

Device is a backup device.

device_error_status

(int1) The error status of the real device. The possible values are:

0

No error.

1

Port name conflict.

2

No layer 2 support.

3

Real device does not exist.

4

Real device is attached elsewhere.

5

Real device is not compatible type.

6

Initialization error.

7

Stalled OSA.

8

Stalled controller.

9

Controller connection severed.

10

Primary or secondary routing conflict.

11

Device is offline.

12

Device was detached.

13

IP/Ethernet type mismatch.

14

Insufficient memory in controller virtual machine.

15

TCP/IP configuration conflict.

16

No link aggregation support.

17

OSA-E attribute mismatch.

18

Reserved for future use.

19

OSA-E is not ready.

20

Reserved for future use.

21

Attempting restart for device.

22

Exclusive user error.

23

Device state is invalid.

24

Port number is invalid for device.

25

No OSA connection isolation.

26

EQID mismatch.

27

Incompatible controller.

28

BACKUP detached.

29

BACKUP not ready.

30

BACKUP attempting restart.

31

EQID mismatch.

32

No HiperSockets bridge support.

33

HiperSockets bridge error.

authorized_user_array_length

(int4) Length of authorized_user_array.

authorized_user_array

(array) An array consisting of zero or more instances of authorized_user_structure, as follows:

authorized_user_structure

(structure) A structure consisting of one set of the following parameters:

authorized_user_structure_length

(int4) The combined length of the remaining parameters in authorized_user_structure (not including this parameter).

grant_userid_length

(int4) Length of grant_userid.

grant_userid

(string,1-8.char42) The userid authorized to connect to the virtual switch.

vlan_array_length

(int4) Length of vlan_array.

vlan_array

(array) An array consisting of zero or more instances of vlan_structure, as follows:

vlan_structure

(structure) A structure consisting of one set of the following parameters:

vlan_structure_length

(int4) The combined length of the remaining parameters in vlan_structure (not including this parameter).

user_vlan_id

(int4) The authorized VLAN ID.

connected_adapter_array_length

(int4) Length of connected_adapter_array.

connected_adapter_array

(array) An array consisting of zero or more instances of connected_adapter_structure, as follows:

connected_adapter_structure_length

(int4) The combined length of the remaining parameters in connected_adapter_structure (not including this parameter).

connected_adapter_structure

(structure) A structure consisting of one set of the following parameters:

adapter_owner_length

(int4) Length of adapter_owner.

adapter_owner

(string,1-8,char42) The userid owning the adapter.

image_device_number_length

(int4) Length of image_device_number.

image_device_number

(string,1-4,char16) The virtual device address of the adapter.

Return and Reason Codes